From 82420c46316b0252d59084c432733703092d57c7 Mon Sep 17 00:00:00 2001 From: Igor Solenov Date: Thu, 24 Nov 2022 11:53:42 +0000 Subject: [PATCH 1/5] [MSI] Base stable api-version commit: '2023-01-31' is based on '2018-11-30' --- .../stable/2023-01-31/ManagedIdentity.json | 661 ++++++++++++++++++ .../2023-01-31/examples/IdentityCreate.json | 51 ++ .../2023-01-31/examples/IdentityDelete.json | 12 + .../2023-01-31/examples/IdentityGet.json | 27 + .../examples/IdentityListByResourceGroup.json | 31 + .../examples/IdentityListBySubscription.json | 30 + .../2023-01-31/examples/IdentityUpdate.json | 34 + .../examples/MsiOperationsList.json | 41 ++ .../examples/SystemAssignedIdentityGet.json | 22 + 9 files changed, 909 insertions(+) create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityCreate.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityDelete.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityGet.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListByResourceGroup.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListBySubscription.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityUpdate.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/MsiOperationsList.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/SystemAssignedIdentityGet.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json new file mode 100644 index 000000000000..34b4bdf0687d --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json @@ -0,0 +1,661 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-11-30", + "title": "ManagedServiceIdentityClient", + "description": "The Managed Service Identity Client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.ManagedIdentity/identities/default": { + "get": { + "operationId": "SystemAssignedIdentities_GetByScope", + "description": "Gets the systemAssignedIdentity available under the specified RP scope.", + "x-ms-examples": { + "MsiOperationsList": { + "$ref": "./examples/SystemAssignedIdentityGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The systemAssignedIdentity was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/SystemAssignedIdentity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.ManagedIdentity/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists available operations for the Microsoft.ManagedIdentity provider", + "x-ms-examples": { + "MsiOperationsList": { + "$ref": "./examples/MsiOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedIdentity/userAssignedIdentities": { + "get": { + "operationId": "UserAssignedIdentities_ListBySubscription", + "description": "Lists all the userAssignedIdentities available under the specified subscription.", + "x-ms-examples": { + "IdentityListBySubscription": { + "$ref": "./examples/IdentityListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of userAssignedIdentities was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UserAssignedIdentitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities": { + "get": { + "operationId": "UserAssignedIdentities_ListByResourceGroup", + "description": "Lists all the userAssignedIdentities available under the specified ResourceGroup.", + "x-ms-examples": { + "IdentityListByResourceGroup": { + "$ref": "./examples/IdentityListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of userAssignedIdentities was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UserAssignedIdentitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}": { + "put": { + "operationId": "UserAssignedIdentities_CreateOrUpdate", + "description": "Create or update an identity in the specified subscription and resource group.", + "x-ms-examples": { + "IdentityCreate": { + "$ref": "./examples/IdentityCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Identity" + }, + "description": "Parameters to create or update the identity" + } + ], + "responses": { + "200": { + "description": "Updated identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "201": { + "description": "Created identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "operationId": "UserAssignedIdentities_Update", + "description": "Update an identity in the specified subscription and resource group.", + "x-ms-examples": { + "IdentityUpdate": { + "$ref": "./examples/IdentityUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IdentityUpdate" + }, + "description": "Parameters to update the identity" + } + ], + "responses": { + "200": { + "description": "Updated identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "operationId": "UserAssignedIdentities_Get", + "description": "Gets the identity.", + "x-ms-examples": { + "IdentityGet": { + "$ref": "./examples/IdentityGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The requested identity.", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "UserAssignedIdentities_Delete", + "description": "Deletes the identity.", + "x-ms-examples": { + "IdentityDelete": { + "$ref": "./examples/IdentityDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Deleted Identity." + }, + "204": { + "description": "The specified identity does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "Identity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "description": "The properties associated with the identity.", + "$ref": "#/definitions/UserAssignedIdentityProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes an identity resource." + }, + "IdentityUpdate": { + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "description": "The properties associated with the identity.", + "$ref": "#/definitions/UserAssignedIdentityProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "Describes an identity resource." + }, + "SystemAssignedIdentity": { + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "description": "The properties associated with the identity.", + "$ref": "#/definitions/SystemAssignedIdentityProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Describes a system assigned identity resource." + }, + "SystemAssignedIdentityProperties": { + "description": "The properties associated with the system assigned identity.", + "type": "object", + "title": "System Assigned Identity properties.", + "properties": { + "tenantId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the tenant which the identity belongs to." + }, + "principalId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the service principal object associated with the created identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the app associated with the identity. This is a random generated UUID by MSI." + }, + "clientSecretUrl": { + "type": "string", + "readOnly": true, + "description": " The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials." + } + } + }, + "UserAssignedIdentityProperties": { + "description": "The properties associated with the user assigned identity.", + "type": "object", + "title": "User Assigned Identity properties.", + "properties": { + "tenantId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the tenant which the identity belongs to." + }, + "principalId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the service principal object associated with the created identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the app associated with the identity. This is a random generated UUID by MSI." + } + } + }, + "UserAssignedIdentitiesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Identity" + }, + "description": "The collection of userAssignedIdentities returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The url to get the next page of results, if any." + } + }, + "description": "Values returned by the List operation." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "description": "A list of additional details about the error.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the ManagedServiceIdentity service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "code" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the ManagedServiceIdentity service." + }, + "Operation": { + "title": "Microsoft.ManagedIdentity Operation.", + "description": "Operation supported by the Microsoft.ManagedIdentity REST API.", + "type": "object", + "properties": { + "name": { + "title": "Operation Name.", + "description": "The name of the REST Operation. This is of the format {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "title": "Operation Display.", + "description": "The object that describes the operation.", + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "title": "Operation Display.", + "description": "The object that describes the operation.", + "properties": { + "provider": { + "title": "Resource Provider Name.", + "description": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "title": "Operation Type.", + "description": "The type of operation. For example: read, write, delete.", + "type": "string" + }, + "resource": { + "title": "Resource Type.", + "description": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "title": "Operation description", + "description": "A description of the operation.", + "type": "string" + } + } + }, + "OperationListResult": { + "title": "Operations List.", + "description": "A list of operations supported by Microsoft.ManagedIdentity Resource Provider.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "title": "Operations List.", + "description": "A list of operations supported by Microsoft.ManagedIdentity Resource Provider." + }, + "nextLink": { + "type": "string", + "title": "Next Link", + "description": "The url to get the next page of results, if any." + } + } + } + }, + "parameters": { + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The resource provider scope of the resource. Parent resource being extended by Managed Identities.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Id of the Subscription to which the identity belongs.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the Resource Group to which the identity belongs.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "description": "The name of the identity resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of API to invoke.", + "required": true, + "type": "string" + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityCreate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityCreate.json new file mode 100644 index 000000000000..d57e15052a87 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityCreate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "parameters": { + "location": "eastus", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityDelete.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityDelete.json new file mode 100644 index 000000000000..0a9700aa8938 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityGet.json new file mode 100644 index 000000000000..f8dca8517fe4 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListByResourceGroup.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListByResourceGroup.json new file mode 100644 index 000000000000..d33cf94d2b6c --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2018-11-30&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListBySubscription.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListBySubscription.json new file mode 100644 index 000000000000..ba8d11b3673f --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListBySubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2018-11-30&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityUpdate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityUpdate.json new file mode 100644 index 000000000000..53d7be02e667 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "parameters": { + "location": "eastus", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/MsiOperationsList.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/MsiOperationsList.json new file mode 100644 index 000000000000..994f8a6e7619 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/MsiOperationsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2018-11-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets an existing user assigned identity", + "operation": "Get User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/read" + }, + { + "display": { + "description": "Creates a new user assigned identity or updates the tags associated with an existing user assigned identity", + "operation": "Create/Update User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/write" + }, + { + "display": { + "description": "Deletes an existing user assigned identity", + "operation": "Delete User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/delete" + } + ], + "nextLink": "https://serviceRoot/providers/Microsoft.ManagedIdentity/operations?api-version=2018-11-30&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/SystemAssignedIdentityGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/SystemAssignedIdentityGet.json new file mode 100644 index 000000000000..f3e08728885f --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/SystemAssignedIdentityGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "scope": "scope" + }, + "responses": { + "200": { + "body": { + "id": "/scope", + "location": "cus", + "name": "resourceName", + "properties": { + "clientId": "clientGUID", + "clientSecretUrl": "https://serviceRoot/scope/credentials?tid=tenantId&oid=principalId&aid=clientId", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "type": "ResourceProvider" + } + } + } +} From 506eaa00886322cd90099c11a2098ebacbc286f7 Mon Sep 17 00:00:00 2001 From: Igor Solenov Date: Thu, 24 Nov 2022 14:17:55 +0000 Subject: [PATCH 2/5] [MSI] 2023-01-31 stable version --- .../stable/2023-01-31/ManagedIdentity.json | 273 +++++++++++++++++- .../FederatedIdentityCredentialCreate.json | 48 +++ .../FederatedIdentityCredentialDelete.json | 13 + .../FederatedIdentityCredentialGet.json | 25 ++ .../FederatedIdentityCredentialList.json | 30 ++ .../2023-01-31/examples/IdentityCreate.json | 14 +- .../2023-01-31/examples/IdentityDelete.json | 2 +- .../2023-01-31/examples/IdentityGet.json | 8 +- .../examples/IdentityListByResourceGroup.json | 10 +- .../examples/IdentityListBySubscription.json | 10 +- .../2023-01-31/examples/IdentityUpdate.json | 8 +- .../examples/MsiOperationsList.json | 4 +- .../examples/SystemAssignedIdentityGet.json | 8 +- specification/msi/resource-manager/readme.md | 10 +- 14 files changed, 429 insertions(+), 34 deletions(-) create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialCreate.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialDelete.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialGet.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialList.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json index 34b4bdf0687d..4ad6b20720fd 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2018-11-30", + "version": "2023-01-31", "title": "ManagedServiceIdentityClient", "description": "The Managed Service Identity Client." }, @@ -348,6 +348,191 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials": { + "get": { + "operationId": "FederatedIdentityCredentials_List", + "description": "Lists all the federated identity credentials under the specified user assigned identity.", + "x-ms-examples": { + "FederatedIdentityCredentialList": { + "$ref": "./examples/FederatedIdentityCredentialList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TopQueryParameter" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of federated identity credentials for the specified user assigned identity was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredentialsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials/{federatedIdentityCredentialResourceName}": { + "put": { + "operationId": "FederatedIdentityCredentials_CreateOrUpdate", + "description": "Create or update a federated identity credential under the specified user assigned identity.", + "x-ms-examples": { + "FederatedIdentityCredentialCreate": { + "$ref": "./examples/FederatedIdentityCredentialCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + }, + "description": "Parameters to create or update the federated identity credential." + } + ], + "responses": { + "200": { + "description": "Updated federated identity credential.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + } + }, + "201": { + "description": "Created federated identity credential.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "operationId": "FederatedIdentityCredentials_Get", + "description": "Gets the federated identity credential.", + "x-ms-examples": { + "FederatedIdentityCredentialGet": { + "$ref": "./examples/FederatedIdentityCredentialGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The requested federated identity credential.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "FederatedIdentityCredentials_Delete", + "description": "Deletes the federated identity credential.", + "x-ms-examples": { + "FederatedIdentityCredentialDelete": { + "$ref": "./examples/FederatedIdentityCredentialDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Deleted federated identity credential." + }, + "204": { + "description": "The specified federated identity credential does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } } }, "definitions": { @@ -367,6 +552,22 @@ ], "description": "Describes an identity resource." }, + "FederatedIdentityCredential": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties associated with the federated identity credential.", + "$ref": "#/definitions/FederatedIdentityCredentialProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Describes a federated identity credential." + }, "IdentityUpdate": { "properties": { "location": { @@ -497,6 +698,51 @@ } } }, + "FederatedIdentityCredentialProperties": { + "description": "The properties associated with a federated identity credential.", + "type": "object", + "title": "Federated identity credential properties.", + "required": [ + "issuer", + "subject", + "audiences" + ], + "properties": { + "issuer": { + "type": "string", + "format": "uri", + "description": "The URL of the issuer to be trusted." + }, + "subject": { + "type": "string", + "description": "The identifier of the external identity." + }, + "audiences": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of audiences that can appear in the issued token." + } + } + }, + "FederatedIdentityCredentialsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FederatedIdentityCredential" + }, + "description": "The collection of federated identity credentials returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The url to get the next page of results, if any." + } + }, + "description": "Values returned by the List operation for federated identity credentials." + }, "UserAssignedIdentitiesListResult": { "properties": { "value": { @@ -656,6 +902,31 @@ "description": "Version of API to invoke.", "required": true, "type": "string" + }, + "TopQueryParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of records to return.", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "SkipTokenParameter": { + "in": "query", + "name": "$skiptoken", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "FederatedIdentityCredentialResourceNameParameter": { + "name": "federatedIdentityCredentialResourceName", + "in": "path", + "description": "The name of the federated identity credential resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" } } } diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialCreate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialCreate.json new file mode 100644 index 000000000000..6ec7359be3b2 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialCreate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-01-31", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "federatedIdentityCredentialResourceName": "ficResourceName", + "parameters": { + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialDelete.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialDelete.json new file mode 100644 index 000000000000..1f1113e12221 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-01-31", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "federatedIdentityCredentialResourceName": "ficResourceName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialGet.json new file mode 100644 index 000000000000..50131080feca --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-01-31", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "federatedIdentityCredentialResourceName": "ficResourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialList.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialList.json new file mode 100644 index 000000000000..f15f099bac04 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-01-31", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "top": "20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/resourceName/federatedIdentityCredentials?api-version=2023-01-31&$skipToken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityCreate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityCreate.json index d57e15052a87..c0ad3e0c9e1f 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityCreate.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityCreate.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-11-30", + "api-version": "2023-01-31", "subscriptionId": "subid", "resourceGroupName": "rgName", "resourceName": "resourceName", @@ -19,9 +19,9 @@ "location": "eastus", "name": "identityName", "properties": { - "clientId": "clientGUID", - "principalId": "identityObjectID", - "tenantId": "tenantGUID" + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" }, "tags": { "key1": "value1", @@ -36,9 +36,9 @@ "location": "eastus", "name": "identityName", "properties": { - "clientId": "clientGUID", - "principalId": "identityObjectID", - "tenantId": "tenantGUID" + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" }, "tags": { "key1": "value1", diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityDelete.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityDelete.json index 0a9700aa8938..ebe07aa3c3f9 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityDelete.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityDelete.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-11-30", + "api-version": "2023-01-31", "subscriptionId": "subid", "resourceGroupName": "rgName", "resourceName": "resourceName" diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityGet.json index f8dca8517fe4..421f29e91dff 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityGet.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityGet.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-11-30", + "api-version": "2023-01-31", "subscriptionId": "subid", "resourceGroupName": "rgName", "resourceName": "resourceName" @@ -12,9 +12,9 @@ "location": "eastus", "name": "identityName", "properties": { - "clientId": "clientGUID", - "principalId": "identityObjectID", - "tenantId": "tenantGUID" + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" }, "tags": { "key1": "value1", diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListByResourceGroup.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListByResourceGroup.json index d33cf94d2b6c..2311a378f052 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListByResourceGroup.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-11-30", + "api-version": "2023-01-31", "subscriptionId": "subid", "resourceGroupName": "rgName" }, @@ -13,9 +13,9 @@ "location": "eastus", "name": "identityName", "properties": { - "clientId": "clientGUID", - "principalId": "identityObjectID", - "tenantId": "tenantGUID" + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" }, "tags": { "key1": "value1", @@ -24,7 +24,7 @@ "type": "Microsoft.ManagedIdentity/userAssignedIdentities" } ], - "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2018-11-30&$skiptoken=X'12345'" + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2023-01-31&$skiptoken=X'12345'" } } } diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListBySubscription.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListBySubscription.json index ba8d11b3673f..aeab80980efc 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListBySubscription.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityListBySubscription.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-11-30", + "api-version": "2023-01-31", "subscriptionId": "subid" }, "responses": { @@ -12,9 +12,9 @@ "location": "eastus", "name": "identityName", "properties": { - "clientId": "clientGUID", - "principalId": "identityObjectID", - "tenantId": "tenantGUID" + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" }, "tags": { "key1": "value1", @@ -23,7 +23,7 @@ "type": "Microsoft.ManagedIdentity/userAssignedIdentities" } ], - "nextLink": "https://serviceRoot/subscriptions/subId/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2018-11-30&$skiptoken=X'12345'" + "nextLink": "https://serviceRoot/subscriptions/subId/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2023-01-31&$skiptoken=X'12345'" } } } diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityUpdate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityUpdate.json index 53d7be02e667..28925d6f293d 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityUpdate.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/IdentityUpdate.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-11-30", + "api-version": "2023-01-31", "subscriptionId": "subid", "resourceGroupName": "rgName", "resourceName": "resourceName", @@ -19,9 +19,9 @@ "location": "eastus", "name": "identityName", "properties": { - "clientId": "clientGUID", - "principalId": "identityObjectID", - "tenantId": "tenantGUID" + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" }, "tags": { "key1": "value1", diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/MsiOperationsList.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/MsiOperationsList.json index 994f8a6e7619..d5ddd2524cd9 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/MsiOperationsList.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/MsiOperationsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-11-30" + "api-version": "2023-01-31" }, "responses": { "200": { @@ -34,7 +34,7 @@ "name": "Microsoft.ManagedIdentity/userAssignedIdentities/delete" } ], - "nextLink": "https://serviceRoot/providers/Microsoft.ManagedIdentity/operations?api-version=2018-11-30&$skiptoken=X'12345'" + "nextLink": "https://serviceRoot/providers/Microsoft.ManagedIdentity/operations?api-version=2023-01-31&$skiptoken=X'12345'" } } } diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/SystemAssignedIdentityGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/SystemAssignedIdentityGet.json index f3e08728885f..b26df03de1c4 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/SystemAssignedIdentityGet.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/SystemAssignedIdentityGet.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-11-30", + "api-version": "2023-01-31", "scope": "scope" }, "responses": { @@ -10,10 +10,10 @@ "location": "cus", "name": "resourceName", "properties": { - "clientId": "clientGUID", + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", "clientSecretUrl": "https://serviceRoot/scope/credentials?tid=tenantId&oid=principalId&aid=clientId", - "principalId": "identityObjectID", - "tenantId": "tenantGUID" + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" }, "type": "ResourceProvider" } diff --git a/specification/msi/resource-manager/readme.md b/specification/msi/resource-manager/readme.md index c67eecab3c3d..21056acfaeb7 100644 --- a/specification/msi/resource-manager/readme.md +++ b/specification/msi/resource-manager/readme.md @@ -26,9 +26,17 @@ These are the global settings for the Managed Service Identity API. ``` yaml openapi-type: arm -tag: package-preview-2022-01 +tag: package-2023-01-31 ``` +### Tag: package-2023-01-31 + +These settings apply only when `--tag=package-2023-01-31` is specified on the command line. + +``` yaml $(tag) == 'package-2023-01-31' +input-file: +- Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json +``` ### Tag: package-preview-2022-01 From 6d636230083a687ab51d62a329c27d56772f428d Mon Sep 17 00:00:00 2001 From: Igor Solenov Date: Wed, 7 Dec 2022 16:22:07 +0000 Subject: [PATCH 3/5] [MSI] 2023-01-31 stable version - Specification is updated based on PR comments --- .../stable/2023-01-31/ManagedIdentity.json | 30 +++++++++++-------- .../FederatedIdentityCredentialCreate.json | 6 ++-- .../FederatedIdentityCredentialDelete.json | 2 +- .../FederatedIdentityCredentialGet.json | 4 +-- .../FederatedIdentityCredentialList.json | 6 ++-- 5 files changed, 26 insertions(+), 22 deletions(-) diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json index 4ad6b20720fd..2817c9e25307 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json @@ -360,10 +360,10 @@ }, "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" @@ -375,7 +375,7 @@ "$ref": "#/parameters/SkipTokenParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -408,10 +408,10 @@ }, "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" @@ -420,7 +420,7 @@ "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" }, { "name": "parameters", @@ -463,10 +463,10 @@ }, "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" @@ -475,7 +475,7 @@ "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -503,10 +503,10 @@ }, "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" @@ -515,7 +515,7 @@ "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -563,7 +563,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource" } ], "description": "Describes a federated identity credential." @@ -734,6 +734,9 @@ "items": { "$ref": "#/definitions/FederatedIdentityCredential" }, + "x-ms-identifiers": [ + "id" + ], "description": "The collection of federated identity credentials returned by the listing operation." }, "nextLink": { @@ -926,6 +929,7 @@ "description": "The name of the federated identity credential resource.", "required": true, "type": "string", + "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{2,119}$", "x-ms-parameter-location": "method" } } diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialCreate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialCreate.json index 6ec7359be3b2..7f1a5045b157 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialCreate.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialCreate.json @@ -1,7 +1,7 @@ { "parameters": { "api-version": "2023-01-31", - "subscriptionId": "subid", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", "resourceGroupName": "rgName", "resourceName": "resourceName", "federatedIdentityCredentialResourceName": "ficResourceName", @@ -18,7 +18,7 @@ "responses": { "201": { "body": { - "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", "name": "ficResourceName", "properties": { "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", @@ -32,7 +32,7 @@ }, "200": { "body": { - "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", "name": "ficResourceName", "properties": { "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialDelete.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialDelete.json index 1f1113e12221..fa1d083b77bf 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialDelete.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialDelete.json @@ -1,7 +1,7 @@ { "parameters": { "api-version": "2023-01-31", - "subscriptionId": "subid", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", "resourceGroupName": "rgName", "resourceName": "resourceName", "federatedIdentityCredentialResourceName": "ficResourceName" diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialGet.json index 50131080feca..2be830514f26 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialGet.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialGet.json @@ -1,7 +1,7 @@ { "parameters": { "api-version": "2023-01-31", - "subscriptionId": "subid", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", "resourceGroupName": "rgName", "resourceName": "resourceName", "federatedIdentityCredentialResourceName": "ficResourceName" @@ -9,7 +9,7 @@ "responses": { "200": { "body": { - "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", "name": "ficResourceName", "properties": { "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialList.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialList.json index f15f099bac04..32ac1b79bb4e 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialList.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/examples/FederatedIdentityCredentialList.json @@ -1,7 +1,7 @@ { "parameters": { "api-version": "2023-01-31", - "subscriptionId": "subid", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", "resourceGroupName": "rgName", "resourceName": "resourceName", "top": "20" @@ -11,7 +11,7 @@ "body": { "value": [ { - "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", "name": "ficResourceName", "properties": { "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", @@ -23,7 +23,7 @@ "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" } ], - "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/resourceName/federatedIdentityCredentials?api-version=2023-01-31&$skipToken=X'12345'" + "nextLink": "https://serviceRoot/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/resourceName/federatedIdentityCredentials?api-version=2023-01-31&$skipToken=X'12345'" } } } From 9aba26077500c80d6eb63b34ee03bc8b9bb94445 Mon Sep 17 00:00:00 2001 From: isolenov <92860848+isolenov@users.noreply.github.com> Date: Tue, 31 Jan 2023 09:53:15 +0000 Subject: [PATCH 4/5] Update ManagedIdentity.json Comments are addressed --- .../stable/2023-01-31/ManagedIdentity.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json index 2817c9e25307..9e951d130f2f 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json @@ -638,7 +638,7 @@ ], "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource" } ], "description": "Describes a system assigned identity resource." From b9d3fed756a3416c0d8cbb4b6e6466c7d0aae3ac Mon Sep 17 00:00:00 2001 From: isolenov <92860848+isolenov@users.noreply.github.com> Date: Tue, 31 Jan 2023 14:36:07 +0000 Subject: [PATCH 5/5] Update ManagedIdentity.json Comments are addressed --- .../stable/2023-01-31/ManagedIdentity.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json index 9e951d130f2f..659a6f083435 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json @@ -547,7 +547,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/TrackedResource" } ], "description": "Describes an identity resource." @@ -599,7 +599,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/Resource" } ], "description": "Describes an identity resource."