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.

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

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
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,291 @@
{
"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"
}
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/azureADOnlyAuthentications/{azureADOnlyAuthenticationName}": {
"get": {
"operationId": "AzureADOnlyAuthentications_Get",
"summary": "Get Azure Active Directory Only Authentication property",
"description": "Gets a Azure Active Directory Only Authentication property for the 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": "#/parameters/workspaceNameParameter"
},
{
"$ref": "#/parameters/azureADOnlyAuthenticationNameParameter"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/AzureADOnlyAuthentication"
},
"description": "OK"
},
"default": {
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
},
"description": ""
}
},
"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 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": "#/parameters/workspaceNameParameter"
},
{
"$ref": "#/parameters/azureADOnlyAuthenticationNameParameter"
},
{
"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": ""
}
},
"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 properties 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": "#/parameters/workspaceNameParameter"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/AzureADOnlyAuthenticationListResult"
},
"description": "OK"
},
"default": {
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
},
"description": ""
}
},
"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": "Azure Active Directory Only Authentication properties",
"required": [
"azureADOnlyAuthentication"
],
"type": "object",
"properties": {
"azureADOnlyAuthentication": {
Copy link
Member

@mentat9 mentat9 Aug 13, 2021

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": "Azure Active Directory Only Authentication configuration state",
"type": "string",
"readOnly": true,
"enum": [
"Consistent",
"InConsistent",
"Updating"
],
"x-ms-enum": {
"name": "AuthenticationState",
"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": "Azure Active Directory Only Authentication 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 Azure 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": "azureADOnlyAuthenticationName",
"description": "name of the property",
"required": true,
"enum": [
"default"
],
"x-ms-enum": {
"name": "AzureADOnlyAuthenticationName",
"modelAsString": true
},
"x-ms-parameter-location": "method"
}
}
}
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",
"azureADOnlyAuthenticationName": "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": {}
}
}
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",
"azureADOnlyAuthenticationName": "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"
}
}
}
}
}
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"
}
}
]
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5370,6 +5370,11 @@
"name": "StorageAccountType",
"modelAsString": true
}
},
"sourceDatabaseDeletionDate": {
"type": "string",
"description": "Specifies the time that the sql pool was deleted",
"format": "date-time"
}
}
},
Expand Down
Loading