swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector customLocations API schemes: - https tags: - name: customLocations paths: /providers/Microsoft.ExtendedLocation/operations: get: tags: - customLocations operationId: microsoftAzureCustomlocationsListoperations description: Lists all available Custom Locations operations. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: Operation details. schema: $ref: '#/definitions/customLocationOperationsList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse deprecated: false x-ms-pageable: nextLinkName: nextLink x-ms-examples: List Custom Locations operations: $ref: ./examples/CustomLocationsListOperations.json summary: Microsoft Azure Get Providers Microsoft Extendedlocation Operations /subscriptions/{subscriptionId}/providers/Microsoft.ExtendedLocation/customLocations: get: tags: - customLocations operationId: microsoftAzureCustomlocationsListbysubscription summary: Microsoft Azure Gets A List Of Custom Locations In A Subscription description: Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/customLocationListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: List Custom Locations by subscription: $ref: ./examples/CustomLocationsListBySubscription.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations: get: tags: - customLocations operationId: microsoftAzureCustomlocationsListbyresourcegroup summary: Microsoft Azure Gets A List Of Custom Locations In The Specified Subscription And Resource Group description: Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location. 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 responses: '200': description: OK schema: $ref: '#/definitions/customLocationListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: List Custom Locations by resource group: $ref: ./examples/CustomLocationsListByResourceGroup.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName} : get: tags: - customLocations operationId: microsoftAzureCustomlocationsGet summary: Microsoft Azure Gets A Custom Location description: Gets the details of the customLocation with a specified resource group and name. 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/ResourceNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/customLocation' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Get Custom Location: $ref: ./examples/CustomLocationsGet.json put: tags: - customLocations operationId: microsoftAzureCustomlocationsCreateorupdate summary: Microsoft Azure Creates Or Updates A Custom Location description: Creates or updates a Custom Location in the specified Subscription and Resource Group 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/ResourceNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/customLocation' description: Parameters supplied to create or update a Custom Location. responses: '200': description: OK schema: $ref: '#/definitions/customLocation' '201': description: Created schema: $ref: '#/definitions/customLocation' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: Create/Update Custom Location: $ref: ./examples/CustomLocationsCreate_Update.json delete: tags: - customLocations operationId: microsoftAzureCustomlocationsDelete summary: Microsoft Azure Deletes A Custom Location description: Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id. 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/ResourceNameParameter' responses: '202': description: Accepted. The response indicates the delete operation is performed in the background. '204': description: NoContent. The response indicates the customLocation resource is already deleted. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: Delete Custom Location: $ref: ./examples/CustomLocationsDelete.json patch: tags: - customLocations operationId: microsoftAzureCustomlocationsUpdate summary: Microsoft Azure Updates A Custom Location description: Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription. 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/ResourceNameParameter' - name: parameters in: body required: true x-ms-client-flatten: true schema: $ref: '#/definitions/patchableCustomLocations' description: The updatable fields of an existing Custom Location. responses: '200': description: OK schema: $ref: '#/definitions/customLocation' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Update Custom Location: $ref: ./examples/CustomLocationsPatch.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}/enabledResourceTypes : get: tags: - customLocations operationId: microsoftAzureCustomlocationsListenabledresourcetypes summary: Microsoft Azure Gets The List Of Enabled Resource Types description: Gets the list of the Enabled Resource Types. 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/ResourceNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/EnabledResourceTypesListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Get Custom Location: $ref: ./examples/CustomLocationsListEnabledResourceTypes.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}/findTargetResourceGroup : post: tags: - customLocations operationId: microsoftAzureCustomlocationsFindtargetresourcegroup summary: Microsoft Azure Gets Matching Target Resource Group For Resource Sync description: Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request. 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/ResourceNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/customLocationFindTargetResourceGroupProperties' description: Parameters of the find target resource group request. responses: '200': description: OK schema: $ref: '#/definitions/customLocationFindTargetResourceGroupResult' '204': description: NoContent. The response indicates there was no matching target resource group for resource sync. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Post Custom Location Find Target Resource Group: $ref: ./examples/CustomLocationsFindTargetResourceGroup.json definitions: customLocationOperationValueDisplay: description: Describes the properties of a Custom Locations Operation Value Display. type: object properties: description: description: The description of the operation. type: string readOnly: true operation: description: The display name of the compute operation. type: string readOnly: true provider: description: The resource provider for the operation. type: string readOnly: true resource: description: The display name of the resource the operation applies to. type: string readOnly: true patchableCustomLocations: description: The Custom Locations patchable resource definition. type: object x-ms-azure-resource: true x-ms-client-flatten: true properties: identity: $ref: '#/definitions/Identity' description: Identity for the resource. properties: $ref: '#/definitions/customLocationProperties' description: The Custom Locations patchable properties. x-ms-client-flatten: true tags: description: Resource tags type: object additionalProperties: type: string Identity: description: Identity for the resource. type: object properties: principalId: description: The principal ID of resource identity. type: string readOnly: true tenantId: description: The tenant ID of resource. type: string readOnly: true type: description: The identity type. type: string enum: - SystemAssigned - None x-ms-enum: name: ResourceIdentityType modelAsString: true EnabledResourceType: description: EnabledResourceType definition. type: object properties: properties: $ref: '#/definitions/EnabledResourceTypeProperties' description: The set of properties for EnabledResourceType specific to a Custom Location x-ms-client-flatten: true systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: Metadata pertaining to creation and last modification of the resource readOnly: true allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource customLocationFindTargetResourceGroupProperties: description: The Find Target Resource Group operation request. type: object properties: labels: description: Labels of the custom resource, this is a map of {key,value} pairs. type: object additionalProperties: type: string customLocationListResult: description: The List Custom Locations operation response. type: object properties: nextLink: description: The URL to use for getting the next set of results. type: string readOnly: true value: description: The list of Custom Locations. type: array readOnly: true items: $ref: '#/definitions/customLocation' x-ms-identifiers: - id customLocationOperation: description: Custom Locations operation. type: object properties: display: $ref: '#/definitions/customLocationOperationValueDisplay' description: Describes the properties of a Custom Locations Operation Value Display. x-ms-client-flatten: true isDataAction: description: Is this Operation a data plane operation type: boolean readOnly: true name: description: The name of the compute operation. type: string readOnly: true origin: description: The origin of the compute operation. type: string readOnly: true EnabledResourceTypeProperties: description: Properties for EnabledResourceType of a custom location. type: object properties: clusterExtensionId: description: Cluster Extension ID type: string extensionType: description: Cluster Extension Type type: string typesMetadata: description: Metadata of the Resource Type type: array items: description: Metadata of the Resource Type. type: object properties: apiVersion: description: Api Version of Resource Type type: string resourceProviderNamespace: description: Resource Provider Namespace of Resource Type type: string resourceType: description: Resource Type type: string x-ms-identifiers: - apiVersion - resourceType - resourceProviderNamespace customLocationFindTargetResourceGroupResult: description: The Find Target Resource Group operation response. type: object properties: matchedResourceSyncRule: description: The matching resource sync rule is the particular resource sync rule that matched the match expressions and labels and had lowest priority. This is the rule responsible for mapping the target resource to the target resource group. type: string readOnly: true targetResourceGroup: description: The target resource group of matching resource sync rule. The labels from the request will be used to find out matching resource sync rule against the selector property of the resource sync rule. The one with highest priority will be returned if there are multiple matching rules. type: string readOnly: true customLocationOperationsList: description: Lists of Custom Locations operations. required: - value type: object properties: nextLink: description: Next page of operations. type: string value: description: Array of customLocationOperation type: array items: $ref: '#/definitions/customLocationOperation' x-ms-identifiers: - name customLocation: description: Custom Locations definition. type: object properties: identity: $ref: '#/definitions/Identity' description: Identity for the resource. properties: $ref: '#/definitions/customLocationProperties' description: The set of properties specific to a Custom Location x-ms-client-flatten: true systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: Metadata pertaining to creation and last modification of the resource readOnly: true allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource EnabledResourceTypesListResult: description: List of EnabledResourceTypes definition. type: object properties: nextLink: description: The URL to use for getting the next set of results. type: string readOnly: true value: description: The list of EnabledResourceTypes available for a customLocation. type: array readOnly: true items: $ref: '#/definitions/EnabledResourceType' x-ms-identifiers: - id customLocationProperties: description: Properties for a custom location. type: object properties: authentication: description: This is optional input that contains the authentication that should be used to generate the namespace. type: object properties: type: description: The type of the Custom Locations authentication type: string value: description: The kubeconfig value. type: string x-ms-mutability: - create - update x-ms-secret: true clusterExtensionIds: description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. type: array items: type: string x-ms-identifiers: - id displayName: description: Display name for the Custom Locations location. type: string hostResourceId: description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. type: string hostType: description: Type of host the Custom Locations is referencing (Kubernetes, etc...). type: string enum: - Kubernetes x-ms-enum: name: HostType modelAsString: true namespace: description: Kubernetes namespace that will be created on the specified cluster. type: string provisioningState: description: Provisioning State for the Custom Location. type: string parameters: ResourceNameParameter: name: resourceName in: path required: true type: string x-ms-parameter-location: method minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ description: Custom Locations name. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'