Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add missing features to be released in 2021-06-01 into 2021-06-01-preview #15602

Merged
merged 5 commits into from
Aug 24, 2021
Merged

Add missing features to be released in 2021-06-01 into 2021-06-01-preview #15602

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bdb2379
Add missing features to be released in 2021-06-01 into 2021-06-01-pre…
Aug 10, 2021
9011d0c
Prettier fix
Aug 12, 2021
f6eafac
Fix naming from review comments
Aug 16, 2021
e706ecc
Fix parameter names in azureADOnlyAuthentication examples
Aug 16, 2021
157d7a7
Remove systemData from azureAdOnlyAuthentication.json
Aug 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
299 changes: 299 additions & 0 deletions ...ource-manager/Microsoft.Synapse/preview/2021-06-01-preview/azureADOnlyAuthentication.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,299 @@
{
"swagger": "2.0",
"info": {
"version": "2021-06-01-preview",
"title": "SynapseManagementClient",
"description": "Azure Synapse Analytics APIs"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"type": "oauth2",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"description": "Azure Active Directory OAuth2 Flow"
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/azureADOnlyAuthentications/{azureADOnlyAuthentication}": {
pilor marked this conversation as resolved.
Show resolved Hide resolved
"get": {
"operationId": "AzureADOnlyAuthentications_Get",
"summary": "Get Azure Active Directory only authentication property",
"description": "Gets a Azure Active Directory only authentication property",
"tags": [
"WorkspaceAzureADOnlyAuthentications"
],
"deprecated": false,
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./azureADOnlyAuthentication.json#/parameters/workspaceNameParameter"
},
{
"$ref": "./azureADOnlyAuthentication.json#/parameters/azureADOnlyAuthenticationNameParameter"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/AzureADOnlyAuthentication"
},
"description": "OK"
},
"default": {
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
},
"description": ""
}
},
"consumes": [],
"produces": [
"application/json"
],
cool-mist marked this conversation as resolved.
Show resolved Hide resolved
"x-ms-examples": {
"Get Azure Active Directory Only Authentication property": {
"$ref": "./examples/GetAzureADOnlyAuthentication.json"
}
}
},
"put": {
"operationId": "AzureADOnlyAuthentications_Create",
"summary": "Create or Update Azure Active Directory only authentication property",
"description": "Create or Update a Azure Active Directory only authentication property for the workspaces",
"tags": [
"WorkspaceAzureADOnlyAuthentications"
],
"deprecated": false,
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./azureADOnlyAuthentication.json#/parameters/workspaceNameParameter"
},
{
"$ref": "./azureADOnlyAuthentication.json#/parameters/azureADOnlyAuthenticationNameParameter"
cool-mist marked this conversation as resolved.
Show resolved Hide resolved
},
{
"schema": {
"$ref": "#/definitions/AzureADOnlyAuthentication"
},
"in": "body",
"name": "AzureADOnlyAuthenticationInfo",
"description": "Azure Active Directory Property",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/AzureADOnlyAuthentication"
},
"description": "OK"
},
"201": {
"schema": {
"$ref": "#/definitions/AzureADOnlyAuthentication"
},
"description": "Created"
},
"202": {
"description": "Accepted"
},
"default": {
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
},
"description": ""
}
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"x-ms-examples": {
"Create or Update Azure Active Directory Only Authentication property": {
"$ref": "./examples/CreateOrUpdateAzureADOnlyAuthentication.json"
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/azureADOnlyAuthentications": {
"get": {
"operationId": "AzureADOnlyAuthentications_List",
"summary": "Gets a list of Azure Active Directory only authentication property",
"description": "Gets a list of Azure Active Directory only authentication property for a workspace",
"tags": [
"WorkspaceAzureADOnlyAuthentications"
],
"deprecated": false,
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./azureADOnlyAuthentication.json#/parameters/workspaceNameParameter"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/AzureADOnlyAuthenticationListResult"
},
"description": "OK"
},
"default": {
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
},
"description": ""
}
},
"consumes": [],
"produces": [
"application/json"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"Get a list of Azure Active Directory Only Authentication property": {
"$ref": "./examples/ListAzureADOnlyAuthentication.json"
}
}
}
}
},
"definitions": {
"AzureADOnlyAuthenticationProperties": {
"description": "Properties of a active directory only authentication.",
"required": [
"azureADOnlyAuthentication"
],
"type": "object",
"properties": {
"azureADOnlyAuthentication": {
Copy link
Member

@mentat9 mentat9 Aug 13, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

azureADOnlyAuthentication

ARM recommends string enum instead of boolean. This is better represented as authenticationType: [ "ActiveDirectoryOnly", "Default (or correct name)", ]. The enum values can actually be used to give information to the API users. #Resolved

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We used boolean to maintain uniformity among similar controllers . For this we refer, SQL and SQL OD API documentation on configuring AzureADOnlyAuthentication, and they all were using boolean. So, we also implemented in a similar fashion.

SQL RP: https://docs.microsoft.com/en-us/rest/api/sql/2021-02-01-preview/server-azure-ad-only-authentications/create-or-update#creates-or-updates-azure-active-directory-only-authentication-object.

"description": "Azure Active Directory only Authentication enabled.",
"type": "boolean"
},
"state": {
"description": "property configuration state",
"type": "string",
"readOnly": true,
"enum": [
"Consistent",
"InConsistent",
"Updating"
],
"x-ms-enum": {
"name": "state value",
cool-mist marked this conversation as resolved.
Show resolved Hide resolved
"modelAsString": true
}
},
"creationDate": {
cool-mist marked this conversation as resolved.
Show resolved Hide resolved
"description": "property configuration date",
"type": "string",
"format": "date-time",
"readOnly": true
}
}
},
"AzureADOnlyAuthentication": {
"description": "Azure Active Directory Only Authentication Info",
"type": "object",
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"description": "azureADOnlyAuthentication resource properties",
"$ref": "#/definitions/AzureADOnlyAuthenticationProperties",
"x-ms-client-flatten": true
},
"systemData": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
"readOnly": true
}
}
},
"AzureADOnlyAuthenticationListResult": {
"description": "A list of active directory only authentications.",
"type": "object",
"properties": {
"value": {
"description": "Array of results.",
"type": "array",
"items": {
"$ref": "#/definitions/AzureADOnlyAuthentication"
},
"readOnly": true
},
"nextLink": {
"description": "Link to retrieve next page of results.",
"type": "string",
"readOnly": true
}
}
}
},
"parameters": {
"workspaceNameParameter": {
"name": "workspaceName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the workspace",
"x-ms-parameter-location": "method"
},
"azureADOnlyAuthenticationNameParameter": {
"type": "string",
"in": "path",
"name": "azureADOnlyAuthentication",
cool-mist marked this conversation as resolved.
Show resolved Hide resolved
"description": "name of the property",
"required": true,
"enum": [
"default"
],
"x-ms-enum": {
"name": "AzureADOnlyAuthenticationName",
"modelAsString": true
},
"x-ms-parameter-location": "method"
}
}
}
41 changes: 41 additions & 0 deletions ....Synapse/preview/2021-06-01-preview/examples/CreateOrUpdateAzureADOnlyAuthentication.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "workspace-6852",
"workspaceName": "workspace-2080",
"azureADOnlyAuthentication": "default",
"api-version": "2021-06-01-preview",
"AzureADOnlyAuthenticationInfo": {
"properties": {
"azureADOnlyAuthentication": true
}
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/azureADOnlyAuthentications/default",
"name": "default",
"type": "Microsoft.Synapse/workspaces/azureADOnlyAuthentications",
"properties": {
"azureADOnlyAuthentication": true,
"creationDate": "2017-02-10T00:56:19.2Z",
"state": "Consistent"
}
}
},
"201": {
"body": {
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/azureADOnlyAuthentications/default",
"name": "default",
"type": "Microsoft.Synapse/workspaces/azureADOnlyAuthentications",
"properties": {
"azureADOnlyAuthentication": true,
"creationDate": "2017-02-10T00:56:19.2Z",
"state": "Updating"
}
}
},
"202": {}
}
}
23 changes: 23 additions & 0 deletions ...r/Microsoft.Synapse/preview/2021-06-01-preview/examples/GetAzureADOnlyAuthentication.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "workspace-6852",
"workspaceName": "workspace-2080",
"azureADOnlyAuthentication": "default",
"api-version": "2021-06-01-preview"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/azureADOnlyAuthentications/default",
"name": "default",
"type": "Microsoft.Synapse/workspaces/azureADOnlyAuthentications",
"properties": {
"azureADOnlyAuthentication": true,
"creationDate": "2017-02-10T00:56:19.2Z",
"state": "Consistent"
}
}
}
}
}
26 changes: 26 additions & 0 deletions .../Microsoft.Synapse/preview/2021-06-01-preview/examples/ListAzureADOnlyAuthentication.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "workspace-6852",
"workspaceName": "workspace-2080",
"api-version": "2021-06-01-preview"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/azureADOnlyAuthentications/default",
"name": "default",
"type": "Microsoft.Synapse/workspaces/azureADOnlyAuthentications",
"properties": {
"azureADOnlyAuthentication": true,
"creationDate": "2017-02-10T00:56:19.2Z",
"state": "Consistent"
}
}
]
}
}
}
}
Loading