swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Subscriptions API schemes: - https tags: - name: Subscriptions paths: /subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters: get: summary: Microsoft Azure Gets A List Of Meters For A Given Location description: Description for Gets a list of meters for a given location. operationId: microsoftAzureListbillingmeters parameters: - name: billingLocation in: query description: Azure Location of billable resource type: string - name: osType in: query description: App Service OS type meters used for type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BillingMeterCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability: post: summary: Microsoft Azure Check If A Resource Name Is Available description: Description for Check if a resource name is available. operationId: microsoftAzureChecknameavailability parameters: - name: request in: body description: Name availability request. required: true schema: $ref: '#/definitions/ResourceNameAvailabilityRequest' x-ms-client-flatten: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceNameAvailability' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Web/customhostnameSites: get: summary: Microsoft Azure Get Custom Hostnames Under This Subscription operationId: microsoftAzureListcustomhostnamesites parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/hostnameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CustomHostnameSitesCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get custom hostnames under subscription: $ref: ./examples/ListCustomHostNameSites.json Get specific custom hostname under subscription: $ref: ./examples/ListCustomSpecificHostNameSites.json x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Web/deploymentLocations: get: summary: Microsoft Azure Gets List Of Available Geo Regions Plus Ministamps description: Description for Gets list of available geo regions plus ministamps operationId: microsoftAzureGetsubscriptiondeploymentlocations parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DeploymentLocations' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Web/aseRegions: get: summary: Microsoft Azure Get A List Of Available Ase Regions And Its Supported Skus description: Description for get a list of available ASE regions and its supported Skus. operationId: microsoftAzureListaseregions parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/AseRegionCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List aseregions: $ref: ./examples/ListAseRegions.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions: get: summary: Microsoft Azure Get A List Of Available Geographical Regions description: Description for Get a list of available geographical regions. operationId: microsoftAzureListgeoregions parameters: - name: sku in: query description: Name of SKU used to filter the regions. type: string enum: - Free - Shared - Basic - Standard - Premium - Dynamic - Isolated - IsolatedV2 - PremiumV2 - PremiumV3 - PremiumContainer - ElasticPremium - ElasticIsolated x-ms-enum: name: SkuName modelAsString: true - name: linuxWorkersEnabled in: query description: Specify true if you want to filter to only regions that support Linux workers. type: boolean - name: xenonWorkersEnabled in: query description: Specify true if you want to filter to only regions that support Xenon workers. type: boolean - name: linuxDynamicWorkersEnabled in: query description: Specify true if you want to filter to only regions that support Linux Consumption Workers. type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/GeoRegionCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Web/listSitesAssignedToHostName: post: summary: Microsoft Azure List All Apps That Are Assigned To A Hostname description: Description for List all apps that are assigned to a hostname. operationId: microsoftAzureListsiteidentifiersassignedtohostname parameters: - name: nameIdentifier in: body description: Hostname information. required: true schema: $ref: ./CommonDefinitions.json#/definitions/NameIdentifier - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/IdentifierCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers: get: summary: Microsoft Azure List All Premier Add On Offers description: Description for List all premier add-on offers. operationId: microsoftAzureListpremieraddonoffers parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PremierAddOnOfferCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Web/skus: get: summary: Microsoft Azure List All Skus description: Description for List all SKUs. operationId: microsoftAzureListskus parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SkuInfos' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/usages: get: summary: Microsoft Azure Lists Subscription Core Usages For All Skus Used In A Location, For A Given Type Of Quota description: List usages in cores for all skus used by a subscription in a given location, for a specific quota type. operationId: microsoftAzureGetusagesinlocationList parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get usages in location for subscription: $ref: ./examples/GetUsagesInLocation.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Web/verifyHostingEnvironmentVnet: post: summary: Microsoft Azure Verifies If This Vnet Is Compatible With An App Service Environment By Analyzing The Network Security Group Rules description: Description for Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules. operationId: microsoftAzureVerifyhostingenvironmentvnet parameters: - name: parameters in: body description: VNET information required: true schema: $ref: '#/definitions/VnetParameters' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetValidationFailureDetails' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: VerifyHostingEnvironmentVnet: $ref: ./examples/VerifyHostingEnvironmentVnet.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources: post: summary: Microsoft Azure Move Resources Between Resource Groups description: Description for Move resources between resource groups. operationId: microsoftAzureMove parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: moveResourceEnvelope in: body description: Object that represents the resource to move. required: true schema: $ref: '#/definitions/CsmMoveResourceEnvelope' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate: post: summary: Microsoft Azure Validate If A Resource Can Be Created description: Description for Validate if a resource can be created. operationId: microsoftAzureValidate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: validateRequest in: body description: Request with the resources to validate. required: true schema: $ref: '#/definitions/ValidateRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ValidateResponse' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources: post: summary: Microsoft Azure Validate Whether A Resource Can Be Moved description: Description for Validate whether a resource can be moved. operationId: microsoftAzureValidatemove parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: moveResourceEnvelope in: body description: Object that represents the resource to move. required: true schema: $ref: '#/definitions/CsmMoveResourceEnvelope' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis : get: tags: - Subscriptions operationId: microsoftAzureWorkspaceapiListbyservice description: Lists all APIs of the workspace in an API Management service instance. externalDocs: url: https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis x-ms-examples: ApiManagementListWorkspaceApis: $ref: ./examples/ApiManagementListWorkspaceApis.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - name: $filter in: query required: false type: string description: '| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
' - $ref: ./apimanagement.json#/parameters/TopQueryParameter - $ref: ./apimanagement.json#/parameters/SkipQueryParameter - name: tags in: query required: false type: string description: Include tags in the response. - name: expandApiVersionSet in: query required: false type: boolean description: Include full ApiVersionSet resource in response - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Paged Result response of Apis. schema: $ref: ./definitions.json#/definitions/ApiCollection default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-odata: ./definitions.json#/definitions/ApiContract summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} : head: tags: - Subscriptions operationId: microsoftAzureWorkspaceapiGetentitytag description: Gets the entity state (Etag) version of the API specified by its identifier. x-ms-examples: ApiManagementHeadWorkspaceApi: $ref: ./examples/ApiManagementHeadWorkspaceApi.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/ApiIdRevParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Specified API entity exists and current entity state version is present in the ETag header. headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid get: tags: - Subscriptions operationId: microsoftAzureWorkspaceapiGet description: Gets the details of the API specified by its identifier. x-ms-examples: ApiManagementGetWorkspaceApiContract: $ref: ./examples/ApiManagementGetWorkspaceApiContract.json ApiManagementGetWorkspaceApiRevision: $ref: ./examples/ApiManagementGetWorkspaceApiRevision.json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/ApiIdRevParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: The response body contains the specified API entity. schema: $ref: ./definitions.json#/definitions/ApiContract headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid put: tags: - Subscriptions operationId: microsoftAzureWorkspaceapiCreateorupdate description: Creates new or updates existing specified API of the workspace in an API Management service instance. x-ms-examples: ApiManagementCreateWorkspaceApi: $ref: ./examples/ApiManagementCreateWorkspaceApi.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/ApiIdRevParameter - name: parameters in: body required: true schema: $ref: ./definitions.json#/definitions/ApiCreateOrUpdateParameter description: Create or update parameters. - $ref: ./apimanagement.json#/parameters/IfMatchOptionalParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: API was successfully updated. schema: $ref: ./definitions.json#/definitions/ApiContract headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string location: description: Location header contains the URL where the status of the long running operation can be checked type: string Azure-AsyncOperation: description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked type: string '201': description: API was successfully created. schema: $ref: ./definitions.json#/definitions/ApiContract headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string location: description: Location header contains the URL where the status of the long running operation can be checked type: string Azure-AsyncOperation: description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked type: string default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid patch: tags: - Subscriptions operationId: microsoftAzureWorkspaceapiUpdate description: Updates the specified API of the workspace in an API Management service instance. x-ms-examples: ApiManagementUpdateWorkspaceApi: $ref: ./examples/ApiManagementUpdateWorkspaceApi.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/ApiIdRevParameter - name: parameters in: body required: true schema: $ref: ./definitions.json#/definitions/ApiUpdateContract description: API Update Contract parameters. - $ref: ./apimanagement.json#/parameters/IfMatchRequiredParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: API was successfully updated. schema: $ref: ./definitions.json#/definitions/ApiContract headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid delete: tags: - Subscriptions operationId: microsoftAzureWorkspaceapiDelete description: Deletes the specified API of the workspace in an API Management service instance. x-ms-examples: ApiManagementDeleteWorkspaceApi: $ref: ./examples/ApiManagementDeleteWorkspaceApi.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/ApiIdRevParameter - name: deleteRevisions in: query required: false type: boolean description: Delete all revisions of the Api. - $ref: ./apimanagement.json#/parameters/IfMatchRequiredParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: The API was successfully deleted. '204': description: The API was successfully deleted. default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags : get: tags: - Subscriptions operationId: microsoftAzureWorkspacetagListbyservice description: Lists a collection of tags defined within a workspace in a service instance. x-ms-examples: ApiManagementListWorkspaceTags: $ref: ./examples/ApiManagementListWorkspaceTags.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - name: $filter in: query required: false type: string description: '| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
' - $ref: ./apimanagement.json#/parameters/TopQueryParameter - $ref: ./apimanagement.json#/parameters/SkipQueryParameter - name: scope in: query required: false type: string description: Scope like 'apis', 'products' or 'apis/{apiId} - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Lists a collection of Tag entities. schema: $ref: ./definitions.json#/definitions/TagCollection default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-odata: ./definitions.json#/definitions/TagContract summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Tags ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId} : head: tags: - Subscriptions operationId: microsoftAzureWorkspacetagGetentitystate description: Gets the entity state version of the tag specified by its identifier. x-ms-examples: ApiManagementHeadWorkspaceTag: $ref: ./examples/ApiManagementHeadWorkspaceTag.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/TagIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Empty response body, ETag header entity state version. headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Tags Tagid get: tags: - Subscriptions operationId: microsoftAzureWorkspacetagGet description: Gets the details of the tag specified by its identifier. x-ms-examples: ApiManagementGetWorkspaceTag: $ref: ./examples/ApiManagementGetWorkspaceTag.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/TagIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: The response body contains the specified Tag entity. schema: $ref: ./definitions.json#/definitions/TagContract headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Tags Tagid put: tags: - Subscriptions operationId: microsoftAzureWorkspacetagCreateorupdate description: Creates a tag. x-ms-examples: ApiManagementCreateWorkspaceTag: $ref: ./examples/ApiManagementCreateWorkspaceTag.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/TagIdParameter - name: parameters in: body required: true schema: $ref: ./definitions.json#/definitions/TagCreateUpdateParameters description: Create parameters. - $ref: ./apimanagement.json#/parameters/IfMatchOptionalParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Tag already exists. headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string schema: $ref: ./definitions.json#/definitions/TagContract '201': description: Tag was created successfully. headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string schema: $ref: ./definitions.json#/definitions/TagContract default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Tags Tagid patch: tags: - Subscriptions operationId: microsoftAzureWorkspacetagUpdate description: Updates the details of the tag specified by its identifier. x-ms-examples: ApiManagementUpdateWorkspaceTag: $ref: ./examples/ApiManagementUpdateWorkspaceTag.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/TagIdParameter - name: parameters in: body required: true schema: $ref: ./definitions.json#/definitions/TagCreateUpdateParameters description: Update parameters. - $ref: ./apimanagement.json#/parameters/IfMatchRequiredParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: The tag details were successfully updated. headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string schema: $ref: ./definitions.json#/definitions/TagContract default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Tags Tagid delete: tags: - Subscriptions operationId: microsoftAzureWorkspacetagDelete description: Deletes specific tag of the workspace in an API Management service instance. x-ms-examples: ApiManagementDeleteWorkspaceTag: $ref: ./examples/ApiManagementDeleteWorkspaceTag.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/TagIdParameter - $ref: ./apimanagement.json#/parameters/IfMatchRequiredParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Tag successfully removed '204': description: Tag successfully removed by previous request or does not exist default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Tags Tagid ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/query : post: operationId: microsoftAzureQueryExecute summary: Microsoft Azure Execute An Analytics Query description: Executes an Analytics query for data. [Here](https://dev.applicationinsights.io/documentation/Using-the-API/Query) is an example for using POST with an Analytics query. x-ms-examples: queryPost: $ref: examples/query-post.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/applicationName' - $ref: '#/parameters/queryBody' - $ref: '#/parameters/apiVersion' responses: '200': description: Successful response schema: $ref: '#/definitions/queryResults' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Subscriptions get: operationId: microsoftAzureQueryGet summary: Microsoft Azure Execute An Analytics Query description: Executes an Analytics query for data x-ms-examples: queryGet: $ref: examples/query-get.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/applicationName' - $ref: '#/parameters/queryParam' - $ref: '#/parameters/queryTimespan' - $ref: '#/parameters/apiVersion' responses: '200': description: Successful response schema: $ref: '#/definitions/queryResults' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/metadata : post: operationId: microsoftAzureMetadataPost summary: Microsoft Azure Gets Metadata Information description: Retrieve the metadata information for the app, including its schema, etc. x-ms-examples: metadataPost: $ref: examples/metadata-post.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/applicationName' - $ref: '#/parameters/apiVersion' responses: '200': description: Successful response schema: $ref: '#/definitions/metadataResults' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Subscriptions get: operationId: microsoftAzureMetadataGet summary: Microsoft Azure Gets Metadata Information description: Retrieve the metadata information for the app, including its schema, etc. x-ms-examples: metadataGet: $ref: examples/metadata-get.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/applicationName' - $ref: '#/parameters/apiVersion' responses: '200': description: Successful response schema: $ref: '#/definitions/metadataResults' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/metrics/{metricId} : get: operationId: microsoftAzureMetricsGet summary: Microsoft Azure Retrieve Metric Data description: Gets metric values for a single metric x-ms-examples: simpleMetric: $ref: examples/metric-get.json intervaledMetric: $ref: examples/metric-get-full.json segmentedIntervaledMetric: $ref: examples/metric-get-segmented.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/applicationName' - $ref: '#/parameters/metricId' - $ref: '#/parameters/metricsTimespan' - $ref: '#/parameters/metricsInterval' - $ref: '#/parameters/metricsAggregation' - $ref: '#/parameters/metricsSegment' - $ref: '#/parameters/metricsTop' - $ref: '#/parameters/metricsOrderBy' - $ref: '#/parameters/metricsFilter' - $ref: '#/parameters/apiVersion' responses: '200': description: Successful response schema: $ref: '#/definitions/metricsResult' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/metrics/metadata : get: operationId: microsoftAzureMetricsGetmetadata summary: Microsoft Azure Retrieve Metric Metadata description: Gets metadata describing the available metrics x-ms-examples: metricMetadata: $ref: examples/metrics-get-metadata.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/applicationName' - $ref: '#/parameters/apiVersion' responses: '200': description: Successful responses schema: type: object default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/events/{eventType} : get: operationId: microsoftAzureEventsGetbytype summary: Microsoft Azure Execute Odata Query description: Executes an OData query for events x-ms-examples: eventByType: $ref: examples/events-get-by-type.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/applicationName' - $ref: '#/parameters/eventType' - $ref: '#/parameters/eventsTimespan' - $ref: '#/parameters/eventsFilter' - $ref: '#/parameters/eventsSearch' - $ref: '#/parameters/eventsOrderBy' - $ref: '#/parameters/eventsSelect' - $ref: '#/parameters/eventsSkip' - $ref: '#/parameters/eventsTop' - $ref: '#/parameters/eventsFormat' - $ref: '#/parameters/eventsCount' - $ref: '#/parameters/eventsApply' - $ref: '#/parameters/apiVersion' responses: '200': description: Successful response schema: $ref: '#/definitions/eventsResults' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/events/{eventType}/{eventId} : get: operationId: microsoftAzureEventsGet summary: Microsoft Azure Get An Event description: Gets the data for a single event x-ms-examples: eventById: $ref: examples/events-get-by-id.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/applicationName' - $ref: '#/parameters/eventType' - $ref: '#/parameters/eventsTimespan' - $ref: '#/parameters/eventId' - $ref: '#/parameters/apiVersion' responses: '200': description: Successful response schema: $ref: '#/definitions/eventsResults' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/events/$metadata : get: operationId: microsoftAzureEventsGetodatametadata summary: Microsoft Azure Get Odata Metadata description: Gets OData EDMX metadata describing the event data model x-ms-examples: eventMetadata: $ref: examples/events-get-metadata.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/applicationName' - $ref: '#/parameters/apiVersion' produces: - application/xml;charset=utf-8 responses: '200': description: Successful response schema: type: object default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/components/{resourceName}/linkedStorageAccounts/{storageType} : get: description: Returns the current linked storage settings for an Application Insights component. operationId: microsoftAzureComponentlinkedstorageaccountsGet parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter' - $ref: '#/parameters/StorageTypeParameter' responses: '200': description: An Application Insights component linked storage accounts. schema: $ref: '#/definitions/ComponentLinkedStorageAccounts' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponseLinkedStorage' x-ms-examples: ComponentLinkedStorageAccountsGet: $ref: ./examples/ComponentLinkedStorageAccountsGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components Resourcename Linkedstorageaccounts Storagetype tags: - Subscriptions put: description: Replace current linked storage account for an Application Insights component. operationId: microsoftAzureComponentlinkedstorageaccountsCreateandupdate parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter' - $ref: '#/parameters/StorageTypeParameter' - name: LinkedStorageAccountsProperties description: Properties that need to be specified to update linked storage accounts for an Application Insights component. in: body required: true schema: $ref: '#/definitions/ComponentLinkedStorageAccounts' responses: '200': description: Successful request when updating linked storage accounts for an Application Insights component. The updated linked storage account is returned. schema: $ref: '#/definitions/ComponentLinkedStorageAccounts' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponseLinkedStorage' x-ms-examples: ComponentLinkedStorageAccountsCreateAndUpdate: $ref: ./examples/ComponentLinkedStorageAccountsCreateAndUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components Resourcename Linkedstorageaccounts Storagetype tags: - Subscriptions patch: description: Update linked storage accounts for an Application Insights component. operationId: microsoftAzureComponentlinkedstorageaccountsUpdate parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter' - $ref: '#/parameters/StorageTypeParameter' - name: LinkedStorageAccountsProperties description: Properties that need to be specified to update a linked storage accounts for an Application Insights component. in: body required: true schema: $ref: '#/definitions/ComponentLinkedStorageAccountsPatch' responses: '200': description: Successful request when updating linked storage accounts for an Application Insights component. The updated linked storage account is returned. schema: $ref: '#/definitions/ComponentLinkedStorageAccounts' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponseLinkedStorage' x-ms-examples: ComponentLinkedStorageAccountsUpdate: $ref: ./examples/ComponentLinkedStorageAccountsUpdate.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components Resourcename Linkedstorageaccounts Storagetype tags: - Subscriptions delete: description: Delete linked storage accounts for an Application Insights component. operationId: microsoftAzureComponentlinkedstorageaccountsDelete parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter' - $ref: '#/parameters/StorageTypeParameter' responses: '200': description: Successful request when deleting linked storage accounts for an Application Insights component. '204': description: Successful request when deleting linked storage accounts for an Application Insights component. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponseLinkedStorage' x-ms-examples: ComponentLinkedStorageAccountsDelete: $ref: ./examples/ComponentLinkedStorageAccountsDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components Resourcename Linkedstorageaccounts Storagetype tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Insights/components: get: description: Gets a list of all Application Insights components within a subscription. operationId: microsoftAzureComponentsList parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter responses: '200': description: A list containing 0 or more Application Insights component definitions. schema: $ref: '#/definitions/ApplicationInsightsComponentListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: ComponentsList.json: $ref: ./examples/ComponentsList.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Insights Components tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components: get: description: Gets a list of Application Insights components within a resource group. operationId: microsoftAzureComponentsListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter responses: '200': description: A list containing 0 or more Application Insights component definitions. schema: $ref: '#/definitions/ApplicationInsightsComponentListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: ComponentListByResourceGroup: $ref: ./examples/ComponentsListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}: delete: description: Deletes an Application Insights component. operationId: microsoftAzureComponentsDelete parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter' responses: '200': description: Successful request when deleting an Application Insights component. '204': description: The specified component does not exist. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: ComponentsDelete: $ref: ./examples/ComponentsDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components Resourcename tags: - Subscriptions get: description: Returns an Application Insights component. operationId: microsoftAzureComponentsGet parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter' responses: '200': description: An Application Insights Component definition. schema: $ref: '#/definitions/ApplicationInsightsComponent' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: ComponentGet: $ref: ./examples/ComponentsGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components Resourcename tags: - Subscriptions put: description: 'Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.' operationId: microsoftAzureComponentsCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter' - name: InsightProperties description: Properties that need to be specified to create an Application Insights component. in: body required: true schema: $ref: '#/definitions/ApplicationInsightsComponent' responses: '200': description: Successful request when creating or updating an Application Insights component. The updated component is returned. schema: $ref: '#/definitions/ApplicationInsightsComponent' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: ComponentCreate: $ref: ./examples/ComponentsCreate.json ComponentUpdate: $ref: ./examples/ComponentsUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components Resourcename tags: - Subscriptions patch: description: Updates an existing component's tags. To update other fields use the CreateOrUpdate method. operationId: microsoftAzureComponentsUpdatetags parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter' - name: ComponentTags description: Updated tag information to set into the component instance. in: body required: true schema: $ref: '#/definitions/TagsResource' responses: '200': description: Updating the Application Insights component's tags was successful. Component tags are updated and returned with the rest of the Component's object properties. schema: $ref: '#/definitions/ApplicationInsightsComponent' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: ComponentUpdateTagsOnly: $ref: ./examples/ComponentsUpdateTagsOnly.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components Resourcename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/purge : post: description: Purges data in an Application Insights component by a set of user-defined filters.

In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected. operationId: microsoftAzureComponentsPurge parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter' - $ref: '#/parameters/ComponentPurgeParameter' responses: '202': description: Accepted request for purging an Application Insights component. schema: $ref: '#/definitions/ComponentPurgeResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: ComponentPurge: $ref: ./examples/ComponentsPurge.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components Resourcename Purge tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/operations/{purgeId} : get: description: Get status for an ongoing purge operation. operationId: microsoftAzureComponentsGetpurgestatus parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter' - $ref: '#/parameters/ComponentPurgeIdParameter' responses: '200': description: 'Returns status of purge operation in body of response. e.g.: running, completed.' schema: $ref: '#/definitions/ComponentPurgeStatusResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: ComponentPurge: $ref: ./examples/ComponentsPurgeStatus.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Components Resourcename Operations Purgeid tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/attestations: get: operationId: microsoftAzureAttestationsListforsubscription description: Gets all attestations for the subscription. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The retrieved attestations. schema: $ref: '#/definitions/AttestationListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List attestations at subscription scope: $ref: ./examples/Attestations_ListSubscriptionScope.json List attestations at subscription scope with query parameters: $ref: ./examples/Attestations_ListSubscriptionScope_WithQuery.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Policyinsights Attestations tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/attestations/{attestationName}: put: operationId: microsoftAzureAttestationsCreateorupdateatsubscription description: Creates or updates an attestation at subscription scope. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/attestationNameParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/Attestation' description: The attestation parameters. responses: '200': description: The updated attestation. schema: $ref: '#/definitions/Attestation' '201': description: The created attestation. schema: $ref: '#/definitions/Attestation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true x-ms-examples: Create attestation at subscription scope: $ref: ./examples/Attestations_CreateSubscriptionScope.json Create attestation at subscription scope with all properties: $ref: ./examples/Attestations_CreateSubscriptionScope_AllProperties.json summary: Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Policyinsights Attestations Attestationname tags: - Subscriptions get: operationId: microsoftAzureAttestationsGetatsubscription description: Gets an existing attestation at subscription scope. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/attestationNameParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The retrieved attestation. schema: $ref: '#/definitions/Attestation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get attestation at subscription scope: $ref: ./examples/Attestations_GetSubscriptionScope.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Policyinsights Attestations Attestationname tags: - Subscriptions delete: operationId: microsoftAzureAttestationsDeleteatsubscription description: Deletes an existing attestation at subscription scope. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/attestationNameParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The attestation was successfully deleted. '204': description: The attestation did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Delete attestation at subscription scope: $ref: ./examples/Attestations_DeleteSubscriptionScope.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Providers Microsoft Policyinsights Attestations Attestationname tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/attestations: get: operationId: microsoftAzureAttestationsListforresourcegroup description: Gets all attestations for the resource group. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The retrieved attestations. schema: $ref: '#/definitions/AttestationListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List attestations at resource group scope: $ref: ./examples/Attestations_ListResourceGroupScope.json List attestations at resource group scope with query parameters: $ref: ./examples/Attestations_ListResourceGroupScope_WithQuery.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Attestations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/attestations/{attestationName} : put: operationId: microsoftAzureAttestationsCreateorupdateatresourcegroup description: Creates or updates an attestation at resource group scope. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/attestationNameParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/Attestation' description: The attestation parameters. responses: '200': description: The updated attestation. schema: $ref: '#/definitions/Attestation' '201': description: The created attestation. schema: $ref: '#/definitions/Attestation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true x-ms-examples: Create attestation at resource group scope: $ref: ./examples/Attestations_CreateResourceGroupScope.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Attestations Attestationname tags: - Subscriptions get: operationId: microsoftAzureAttestationsGetatresourcegroup description: Gets an existing attestation at resource group scope. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/attestationNameParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The retrieved attestation. schema: $ref: '#/definitions/Attestation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get attestation at resource group scope: $ref: ./examples/Attestations_GetResourceGroupScope.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Attestations Attestationname tags: - Subscriptions delete: operationId: microsoftAzureAttestationsDeleteatresourcegroup description: Deletes an existing attestation at resource group scope. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/attestationNameParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The attestation was successfully deleted. '204': description: The attestation did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Delete attestation at resource group scope: $ref: ./examples/Attestations_DeleteResourceGroupScope.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Attestations Attestationname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName} : put: description: Create a new action group or update an existing one. operationId: microsoftAzureActiongroupsCreateorupdate x-ms-examples: Create or update an action group: $ref: ./examples/createOrUpdateActionGroup.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActionGroupNameParameter' - name: actionGroup in: body required: true schema: $ref: '#/definitions/ActionGroupResource' description: The action group to create or use for the update. - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: An existing action group was successfully updated. schema: $ref: '#/definitions/ActionGroupResource' '201': description: A new action group was successfully created. schema: $ref: '#/definitions/ActionGroupResource' default: description: An error occurred and the action group could not be created or updated. schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname tags: - Subscriptions get: description: Get an action group. operationId: microsoftAzureActiongroupsGet x-ms-examples: Get an action group: $ref: ./examples/getActionGroup.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActionGroupNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/ActionGroupResource' default: description: 'An error occurred and the action group could not be retrieved. 404: The action group does not exist.' schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname tags: - Subscriptions delete: description: Delete an action group. operationId: microsoftAzureActiongroupsDelete x-ms-examples: Delete an action group: $ref: ./examples/deleteActionGroup.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActionGroupNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The action group was successfully deleted. '204': description: The action group does not exist. It may have already been deleted. default: description: An error occurred and the action group could not be deleted. schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname tags: - Subscriptions patch: description: Updates an existing action group's tags. To update other fields use the CreateOrUpdate method. operationId: microsoftAzureActiongroupsUpdate parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActionGroupNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: actionGroupPatch in: body required: true schema: $ref: '#/definitions/ActionGroupPatchBody' description: Parameters supplied to the operation. responses: '200': description: An existing action group was successfully updated. schema: $ref: '#/definitions/ActionGroupResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-examples: Patch an action group: $ref: ./examples/patchActionGroup.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Insights/createNotifications: post: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location description: Send test notifications to a set of provided receivers operationId: microsoftAzureActiongroupsPosttestnotifications x-ms-examples: Create notifications at subscription level: $ref: ./examples/postTestNotifications.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: notificationRequest in: body required: true schema: $ref: '#/definitions/NotificationRequestBody' description: The notification request body which includes the contact details responses: '200': description: The notification succeeded schema: $ref: '#/definitions/TestNotificationDetailsResponse' '202': description: The notification request accepted headers: location: type: string description: The location header that has the polling uri. default: description: An error occurred while sending the test notifications schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Insights Createnotifications tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/createNotifications: post: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location description: Send test notifications to a set of provided receivers operationId: microsoftAzureActiongroupsCreatenotificationsatresourcegrouplevel x-ms-examples: Create notifications at resource group level: $ref: ./examples/postTestNotificationsAtResourceGroupLevel.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: notificationRequest in: body required: true schema: $ref: '#/definitions/NotificationRequestBody' description: The notification request body which includes the contact details responses: '200': description: The notification succeeded schema: $ref: '#/definitions/TestNotificationDetailsResponse' '202': description: The notification request accepted headers: location: type: string description: The location header that has the polling uri. default: description: An error occurred while sending the test notifications schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Createnotifications tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/createNotifications : post: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location description: Send test notifications to a set of provided receivers operationId: microsoftAzureActiongroupsCreatenotificationsatactiongroupresourcelevel x-ms-examples: Create notifications at resource group level: $ref: ./examples/postTestNotificationsAtActionGroupResourceLevel.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActionGroupNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: notificationRequest in: body required: true schema: $ref: '#/definitions/NotificationRequestBody' description: The notification request body which includes the contact details responses: '200': description: The notification succeeded schema: $ref: '#/definitions/TestNotificationDetailsResponse' '202': description: The notification request accepted headers: location: type: string description: The location header that has the polling uri. default: description: An error occurred while sending the test notifications schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname Createnotifications tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Insights/notificationStatus/{notificationId}: get: description: Get the test notifications by the notification id operationId: microsoftAzureActiongroupsGettestnotifications x-ms-examples: Get notification details at subscription level: $ref: ./examples/getTestNotifications.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/NotificationIdParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The notification details schema: $ref: '#/definitions/TestNotificationDetailsResponse' default: description: An error occurred while sending the test notifications schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Insights Notificationstatus Notificationid tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/notificationStatus/{notificationId} : get: description: Get the test notifications by the notification id operationId: microsoftAzureActiongroupsGettestnotificationsatresourcegrouplevel x-ms-examples: Get notification details at resource group level: $ref: ./examples/getTestNotificationsAtResourceGroupLevel.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NotificationIdParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The notification details schema: $ref: '#/definitions/TestNotificationDetailsResponse' default: description: An error occurred while sending the test notifications schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Notificationstatus Notificationid tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/notificationStatus/{notificationId} : get: description: Get the test notifications by the notification id operationId: microsoftAzureActiongroupsGettestnotificationsatactiongroupresourcelevel x-ms-examples: Get notification details at resource group level: $ref: ./examples/getTestNotificationsAtActionGroupResourceLevel.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActionGroupNameParameter' - $ref: '#/parameters/NotificationIdParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The notification details schema: $ref: '#/definitions/TestNotificationDetailsResponse' default: description: An error occurred while sending the test notifications schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname Notificationstatus Notificationid tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Insights/actionGroups: get: description: Get a list of all action groups in a subscription. operationId: microsoftAzureActiongroupsListbysubscriptionid x-ms-examples: List action groups at subscription level: $ref: ./examples/listActionGroups.json x-ms-pageable: nextLinkName: null parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/ActionGroupList' default: description: An error occurred and the list of action groups could not be retrieved. schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Insights Actiongroups tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups: get: description: Get a list of all action groups in a resource group. operationId: microsoftAzureActiongroupsListbyresourcegroup x-ms-examples: List action groups at resource group level: $ref: ./examples/listActionGroups.json x-ms-pageable: nextLinkName: null parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/ActionGroupList' default: description: An error occurred and the list of action groups could not be retrieved. schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/subscribe : post: description: Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers. operationId: microsoftAzureActiongroupsEnablereceiver x-ms-examples: Enable the receiver: $ref: ./examples/enableReceiver.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActionGroupNameParameter' - name: enableRequest in: body required: true schema: $ref: '#/definitions/EnableRequest' description: The receiver to re-enable. - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The receiver was successfully enabled. '409': description: The receiver is already enabled in the action group. x-ms-error-response: true default: description: 'An error occurred and the receiver could not be enabled, e.g.: 404: The action group was not found or no matching receiver was found in the action group.' schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Actiongroups Actiongroupname Subscribe tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName} : put: description: Create a new Activity Log Alert rule or update an existing one. operationId: microsoftAzureActivitylogalertsCreateorupdate x-ms-examples: Create or update an Activity Log Alert rule: $ref: ./examples/ActivityLogAlertRule_CreateOrUpdate.json Create or update an Activity Log Alert rule with 'anyOf' condition: $ref: ./examples/ActivityLogAlertRule_CreateOrUpdateRuleWithAnyOfCondition.json Create or update an Activity Log Alert rule with 'containsAny': $ref: ./examples/ActivityLogAlertRule_CreateOrUpdateRuleWithContainsAny.json Create or update an Activity Log Alert rule for tenant level events: $ref: ./examples/ActivityLogAlertRule_CreateOrUpdateTenantLevelServiceHealthRule.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActivityLogAlertNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: activityLogAlertRule description: The Activity Log Alert rule to create or use for the update. in: body required: true schema: $ref: '#/definitions/ActivityLogAlertResource' responses: '200': description: An existing Activity Log Alert rule was successfully updated. schema: $ref: '#/definitions/ActivityLogAlertResource' '201': description: A new Activity Log Alert rule was successfully created. schema: $ref: '#/definitions/ActivityLogAlertResource' default: description: An error occurred and the Activity Log Alert rule could not be created or updated. schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Activitylogalerts Activitylogalertname tags: - Subscriptions get: description: Get an Activity Log Alert rule. operationId: microsoftAzureActivitylogalertsGet x-ms-examples: Get an Activity Log Alert rule: $ref: ./examples/ActivityLogAlertRule_Get.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActivityLogAlertNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/ActivityLogAlertResource' default: description: An error occurred and the Activity Log Alert rule could not be retrieved. schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Activitylogalerts Activitylogalertname tags: - Subscriptions delete: description: Delete an Activity Log Alert rule. operationId: microsoftAzureActivitylogalertsDelete x-ms-examples: Delete an Activity Log Alert rule: $ref: ./examples/ActivityLogAlertRule_Delete.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActivityLogAlertNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The Activity Log Alert rule was successfully deleted. '204': description: The Activity Log Alert rule does not exist. It may have already been deleted. default: description: An error occurred and the Activity Log Alert rule could not be deleted. schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Activitylogalerts Activitylogalertname tags: - Subscriptions patch: description: Updates 'tags' and 'enabled' fields in an existing Alert rule. This method is used to update the Alert rule tags, and to enable or disable the Alert rule. To update other fields use CreateOrUpdate operation. operationId: microsoftAzureActivitylogalertsUpdate x-ms-examples: Patch an Activity Log Alert rule: $ref: ./examples/ActivityLogAlertRule_Update.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ActivityLogAlertNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: activityLogAlertRulePatch in: body required: true schema: $ref: '#/definitions/AlertRulePatchObject' description: Parameters supplied to the operation. responses: '200': description: An existing Activity Log Alert rule was successfully updated. schema: $ref: '#/definitions/ActivityLogAlertResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Activitylogalerts Activitylogalertname tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Insights/activityLogAlerts: get: description: Get a list of all Activity Log Alert rules in a subscription. operationId: microsoftAzureActivitylogalertsListbysubscriptionid x-ms-examples: Get list of all Activity Log Alert rules under a subscription: $ref: ./examples/ActivityLogAlertRule_ListBySubscriptionId.json x-ms-pageable: nextLinkName: nextLink parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/AlertRuleList' default: description: An error occurred and the list of Activity Log Alert rules could not be retrieved. schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Insights Activitylogalerts tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts: get: description: Get a list of all Activity Log Alert rules in a resource group. operationId: microsoftAzureActivitylogalertsListbyresourcegroup x-ms-examples: List activity log alerts: $ref: ./examples/ActivityLogAlertRule_ListByResourceGroupName.json x-ms-pageable: nextLinkName: nextLink parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/AlertRuleList' default: description: An error occurred and the list of Activity Log Alert rules could not be retrieved. schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Activitylogalerts tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}: delete: operationId: microsoftAzureSupportplantypesDelete description: Cancels the Canonical support plan of type {type} for the subscription. x-ms-long-running-operation: true x-ms-examples: SupportPlanTypes_Delete: $ref: ./examples/SupportPlanTypes_Delete.json parameters: - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/SupportProviderName' - $ref: '#/parameters/CanonicalSupportPlanType' responses: '202': description: Accepted headers: {} schema: $ref: '#/definitions/CanonicalSupportPlanResponseEnvelope' '204': description: No Content default: description: BadRequest schema: $ref: '#/definitions/ErrorDefinition_2' summary: Microsoft Azure Delete Subscriptions Subscriptionid Providers Microsoft Addons Supportproviders Providername Supportplantypes Plantypename tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.ApiCenter/services: get: tags: - Subscriptions operationId: microsoftAzureServicesListbysubscription description: Lists services within an Azure subscription. x-ms-examples: Services_ListBySubscription: $ref: ./examples/Services_ListBySubscription.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: The service list. schema: $ref: '#/definitions/ServiceCollection' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Apicenter Services /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services: get: tags: - Subscriptions operationId: microsoftAzureServicesListbyresourcegroup description: Lists services within a resource group x-ms-examples: Services_ListByResourceGroup: $ref: ./examples/Services_ListByResourceGroup.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: Operation completed successfully. schema: $ref: '#/definitions/ServiceCollection' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apicenter Services /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}: get: tags: - Subscriptions operationId: microsoftAzureServicesGet description: Get service x-ms-examples: Services_Get: $ref: ./examples/Services_Get.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ServiceName' responses: '200': description: Operation completed successfully. schema: $ref: '#/definitions/Service' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apicenter Services Servicename put: tags: - Subscriptions operationId: microsoftAzureServicesCreateorupdate description: Create or update service x-ms-examples: Services_Create: $ref: ./examples/Services_CreateOrUpdate.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ServiceName' - name: resource in: body description: The service entity. schema: $ref: '#/definitions/Service' responses: '200': description: The service was successfully updated. schema: $ref: '#/definitions/Service' '201': description: The service was successfully created. schema: $ref: '#/definitions/Service' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apicenter Services Servicename patch: tags: - Subscriptions operationId: microsoftAzureServicesUpdate description: Update service x-ms-examples: Services_Update: $ref: ./examples/Services_Update.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ServiceName' - name: parameters in: body description: The service properties to be updated. schema: $ref: '#/definitions/ServiceUpdate' responses: '200': description: The service was successfully updated. schema: $ref: '#/definitions/Service' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apicenter Services Servicename delete: tags: - Subscriptions operationId: microsoftAzureServicesDelete description: Delete service x-ms-examples: Services_Delete: $ref: ./examples/Services_Delete.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ServiceName' responses: '200': description: Resource deleted successfully. '204': description: Resource deleted successfully. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apicenter Services Servicename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scom/managedInstances/{instanceName} : get: operationId: microsoftAzureInstancesGet description: Get SCOM managed instance details parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/instanceName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: Operation completed successfully. schema: $ref: '#/definitions/ManagedInstance' default: description: An error response providing a description of the reason for the operation's failure. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Instances_Get: $ref: ./examples/Instance_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scom Managedinstances Instancename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scom/managedInstances/{instanceName}/setServerCount : post: operationId: microsoftAzureInstancesScale description: Scaling SCOM managed instance. consumes: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/instanceName' - name: body in: body required: true schema: $ref: '#/definitions/ScalingProperties' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The Scaling has completed successfully. schema: $ref: '#/definitions/setServerCountResponseProperties' '202': description: Accepted. The Scaling will complete asyncronously. headers: Location: type: string Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: An error response providing a description of the reason for the operation's failure. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Instances_Scale: $ref: ./examples/Instance_Scale.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scom Managedinstances Instancename Setservercount tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scom/managedInstances/{instanceName}/patchServers : post: operationId: microsoftAzureInstancesPatchservers description: Update SCOM servers with latest scom software. consumes: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/instanceName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The update process for SCOM Servers has been completed successfully. schema: $ref: '#/definitions/patchServersResponseProperties' '202': description: Accepted. The Updating of SCOM Servers will complete asyncronously. headers: Location: type: string Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: An error response providing a description of the reason for the operation's failure. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Instances_PatchServers: $ref: ./examples/Instances_PatchServers.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scom Managedinstances Instancename Patchservers tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scom/managedInstances/{instanceName}/linkLogAnalytics : post: operationId: microsoftAzureInstancesLinkloganalytics description: Link Log Analytics workspace for SCOM monitoring instance consumes: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/instanceName' - name: body in: body required: true schema: $ref: '#/definitions/logAnalyticsConfiguration' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The Log Analytics linking has completed successfully. schema: $ref: '#/definitions/logAnalyticsConfiguration' '202': description: Accepted. The Log Analytics linking will complete asyncronously. headers: Location: type: string Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Instances_LinkLogAnalytics: $ref: ./examples/Instance_LinkLogAnalytics.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scom Managedinstances Instancename Linkloganalytics tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scom/managedInstances/{instanceName}/unlinkLogAnalytics : post: operationId: microsoftAzureInstancesUnlinkloganalytics description: Unlink Log Analytics workspace for SCOM monitoring instance parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/instanceName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. Unlinked Log Analytics association with managed instance successfully. schema: $ref: '#/definitions/unlinkLogAnalyticsResponseProperties' '202': description: Accepted. Disabling Log Analytics association with managed instance will complete asyncronously. headers: Location: type: string Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Instances_UnlinkLogAnalytics: $ref: ./examples/Instance_UnlinkLogAnalytics.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scom Managedinstances Instancename Unlinkloganalytics tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scom/managedInstances/{instanceName}/updateLogAnalytics : post: operationId: microsoftAzureInstancesUpdateloganalytics description: Update configuration for log analytics linking for SCOM monitoring instance consumes: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/instanceName' - name: body in: body required: true schema: $ref: '#/definitions/logAnalyticsUpdateConfiguration' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The Log Analytics configuration update has completed successfully. schema: $ref: '#/definitions/logAnalyticsUpdateConfiguration' '202': description: Accepted. The Log Analytics configuration update will complete asyncronously. headers: Location: type: string Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Instances_UpdateLogAnalytics: $ref: ./examples/Instance_UpdateLogAnalytics.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scom Managedinstances Instancename Updateloganalytics tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName} : put: tags: - Subscriptions operationId: microsoftAzureCloudhsmclustersCreateorupdate description: Create or Update a Cloud HSM Cluster in the specified subscription. x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: original-uri parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/cloudHsmClusterName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: body required: true x-ms-client-flatten: true schema: $ref: '#/definitions/CloudHsmCluster' description: Parameters to create Cloud HSM Cluster responses: '200': description: Created or Update Cloud HSM Cluster schema: $ref: '#/definitions/CloudHsmCluster' '201': description: Created or Update Cloud HSM Cluster schema: $ref: '#/definitions/CloudHsmCluster' default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-examples: CloudHsmCluster_CreateOrUpdate_MaximumSet_Gen: $ref: ./examples/CloudHsmCluster_CreateOrUpdate_MaximumSet_Gen.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters Cloudhsmclustername patch: tags: - Subscriptions operationId: microsoftAzureCloudhsmclustersUpdate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location description: Update a Cloud HSM Cluster in the specified subscription. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/cloudHsmClusterName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: body required: true x-ms-client-flatten: true schema: $ref: '#/definitions/CloudHsmClusterPatchParameters' description: Parameters to create Cloud HSM Cluster responses: '200': description: Patched Cloud HSM Cluster schema: $ref: '#/definitions/CloudHsmCluster' '202': description: Accepted and the operation will complete asynchronously. headers: Location: description: The URI to poll for completion status. type: string default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-examples: CloudHsmCluster_Update_MaximumSet_Gen: $ref: ./examples/CloudHsmCluster_Update_MaximumSet_Gen.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters Cloudhsmclustername get: tags: - Subscriptions operationId: microsoftAzureCloudhsmclustersGet description: Gets the specified Cloud HSM Cluster parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/cloudHsmClusterName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Retrieved Cloud HSM Cluster schema: $ref: '#/definitions/CloudHsmCluster' default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-examples: CloudHsmCluster_Get_MaximumSet_Gen: $ref: ./examples/CloudHsmCluster_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters Cloudhsmclustername delete: tags: - Subscriptions operationId: microsoftAzureCloudhsmclustersDelete description: Deletes the specified Cloud HSM Cluster x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/cloudHsmClusterName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: OK Response. '202': description: Accepted headers: Location: description: The URI to poll for completion status. type: string '204': description: No Content default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-examples: CloudHsmCluster_Delete_MaximumSet_Gen: $ref: ./examples/CloudHsmCluster_Delete_MaximumSet_Gen.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters Cloudhsmclustername ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters : get: tags: - Subscriptions operationId: microsoftAzureCloudhsmclustersListbyresourcegroup description: The List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - in: query name: $skiptoken type: string required: false description: The page-continuation token to use with a paged version of this API - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Get information about all Cloud HSM Clusters in the specified resource group. schema: $ref: '#/definitions/CloudHsmClusterListResult' default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: CloudHsmCluster_ListByResourceGroup_MaximumSet_Gen: $ref: ./examples/CloudHsmCluster_ListByResourceGroup_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters /subscriptions/{subscriptionId}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters: get: tags: - Subscriptions operationId: microsoftAzureCloudhsmclustersListbysubscription description: The List operation gets information about the Cloud HSM Clusters associated with the subscription. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - in: query name: $skiptoken type: string required: false description: The page-continuation token to use with a paged version of this API - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Get information about all Cloud HSM Clusters in the specified subscription. schema: $ref: '#/definitions/CloudHsmClusterListResult' default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: CloudHsmCluster_ListBySubscription_MaximumSet_Gen: $ref: ./examples/CloudHsmCluster_ListBySubscription_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateLinkResources : get: tags: - Subscriptions operationId: microsoftAzureCloudhsmclusterprivatelinkresourcesListbycloudhsmcluster description: Gets the private link resources supported for the Cloud Hsm Cluster. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/cloudHsmClusterName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Successfully retrieved private link resources. schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-examples: CloudHsmClusterPrivateLinkResources_ListByResource_MaximumSet_Gen: $ref: ./examples/CloudHsmClusterPrivateLinkResource_ListByCloudHsmCluster_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters Cloudhsmclustername Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateEndpointConnections/{peConnectionName} : put: tags: - Subscriptions operationId: microsoftAzureCloudhsmclusterprivateendpointconnectionsCreate description: Creates or updates the private endpoint connection for the Cloud Hsm Cluster. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/cloudHsmClusterName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/peConnectionName' - in: body name: properties required: true schema: $ref: '#/definitions/PrivateEndpointConnection' description: Parameters of the PrivateEndpointConnection responses: '200': description: OK -- Create or Update the private endpoint connection properties successfully. schema: $ref: '#/definitions/PrivateEndpointConnection' default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-examples: CloudHsmClusterPrivateEndpointConnection_Create_MaximumSet_Gen: $ref: ./examples/CloudHsmClusterPrivateEndpointConnection_Create_MaximumSet_Gen.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters Cloudhsmclustername Privateendpointconnections Peconnectionname delete: tags: - Subscriptions operationId: microsoftAzureCloudhsmclusterprivateendpointconnectionsDelete description: Deletes the private endpoint connection for the Cloud Hsm Cluster. x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/cloudHsmClusterName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/peConnectionName' responses: '200': description: The private endpoint connection was successfully deleted. '202': description: The private endpoint connection is being deleted. headers: Location: description: The URI to poll for completion status. type: string '204': description: The private endpoint connection does not exist. default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-examples: CloudHsmClusterPrivateEndpointConnection_Delete_MaximumSet_Gen: $ref: ./examples/CloudHsmClusterPrivateEndpointConnection_Delete_MaximumSet_Gen.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters Cloudhsmclustername Privateendpointconnections Peconnectionname get: tags: - Subscriptions operationId: microsoftAzureCloudhsmclusterprivateendpointconnectionsGet description: Gets the private endpoint connection for the Cloud Hsm Cluster. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/cloudHsmClusterName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/peConnectionName' responses: '200': description: Private endpoint connection successfully returned. schema: $ref: '#/definitions/PrivateEndpointConnection' default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-examples: CloudHsmClusterPrivateEndpointConnection_Get_MaximumSet_Gen: $ref: ./examples/CloudHsmClusterPrivateEndpointConnection_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters Cloudhsmclustername Privateendpointconnections Peconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateEndpointConnections : get: tags: - Subscriptions operationId: microsoftAzurePrivateendpointconnectionsListbycloudhsmcluster description: The List operation gets information about the private endpoint connections associated with the Cloud HSM Cluster parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/cloudHsmClusterName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: List of all CloudHsmCluster private endpoint connections associated with the Cloud HSM Cluster. schema: $ref: '#/definitions/PrivateEndpointConnectionListResult' default: description: The error response describing why the operation failed. schema: $ref: '#/definitions/CloudHsmClusterError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: CloudHsmClusterPrivateEndpointConnection_ListByResource_MaximumSet_Gen: $ref: ./examples/CloudHsmClusterPrivateEndpointConnection_ListByCloudHsmCluster_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hardwaresecuritymodules Cloudhsmclusters Cloudhsmclustername Privateendpointconnections /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}: put: operationId: microsoftAzureBotsCreate x-ms-examples: BotCreate: $ref: ./examples/ResourceCreationPut.json description: Create a new Azure Health Bot. parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/resourceNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/HealthBot' description: The parameters to provide for the created Azure Health Bot. - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: If resource is updated successfully, the service should return 200. schema: $ref: '#/definitions/HealthBot' '201': description: If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously. schema: $ref: '#/definitions/HealthBot' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Healthbot Healthbots Botname tags: - Subscriptions get: operationId: microsoftAzureBotsGet x-ms-examples: ResourceInfoGet: $ref: ./examples/ResourceInfoGet.json description: Get a HealthBot. parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: If resource is got successfully, the service should return 200. schema: $ref: '#/definitions/HealthBot' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Healthbot Healthbots Botname tags: - Subscriptions patch: operationId: microsoftAzureBotsUpdate x-ms-examples: BotUpdate: $ref: ./examples/ResourceUpdatePatch.json description: Patch a HealthBot. parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/resourceNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/HealthBotUpdateParameters' description: The parameters to provide for the required Azure Health Bot. - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: If resource is patched successfully, the service should return 200. schema: $ref: '#/definitions/HealthBot' '201': description: If resource is received update request successfully, the service should return 201 (Created). Execution to continue asynchronously. schema: $ref: '#/definitions/HealthBot' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error' x-ms-long-running-operation: true summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Healthbot Healthbots Botname tags: - Subscriptions delete: operationId: microsoftAzureBotsDelete x-ms-examples: BotDelete: $ref: ./examples/ResourceDeletionDelete.json description: Delete a HealthBot. parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: If resource is deleted successfully, the service should return 200. '202': description: Accepted - Delete request accepted; operation will complete asynchronously '204': description: No content. default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error' x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Healthbot Healthbots Botname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}/listSecrets : post: operationId: microsoftAzureBotsListsecrets x-ms-examples: Bot List Secrets: $ref: ./examples/ListSecrets.json description: List all secrets of a HealthBot. parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: If secrets are retrieved successfully, the service should return 200 (OK). schema: $ref: '#/definitions/HealthBotKeysResponse' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Healthbot Healthbots Botname Listsecrets tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}/regenerateApiJwtSecret : post: operationId: microsoftAzureBotsRegenerateapijwtsecret x-ms-examples: Bot Regenerate API JWT Secret: $ref: ./examples/RegenerateApiJwtSecret.json description: Regenerate the API JWT Secret of a HealthBot. parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: If secret was regenerated successfully, the service should return 200 (OK). schema: $ref: '#/definitions/HealthBotKey' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Healthbot Healthbots Botname Regenerateapijwtsecret tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots: get: description: Returns all the resources of a particular type belonging to a resource group operationId: microsoftAzureBotsListbyresourcegroup x-ms-examples: List Bots by Resource Group: $ref: ./examples/ListBotsByResourceGroup.json parameters: - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed." schema: $ref: '#/definitions/BotResponseList' default: description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned. schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Healthbot Healthbots tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.HealthBot/healthBots: get: description: Returns all the resources of a particular type belonging to a subscription. operationId: microsoftAzureBotsList x-ms-examples: List Bots by Subscription: $ref: ./examples/ListBotsBySubscription.json parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: 'The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code. The nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility. For a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ' schema: $ref: '#/definitions/BotResponseList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Healthbot Healthbots tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/queryPacks: get: description: Gets a list of all Log Analytics QueryPacks within a subscription. operationId: microsoftAzureQuerypacksList parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter responses: '200': description: A list containing 0 or more Log Analytics QueryPack definitions. schema: $ref: '#/definitions/LogAnalyticsQueryPackListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_4' x-ms-examples: QueryPacksList.json: $ref: ./examples/QueryPacksList.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Operationalinsights Querypacks tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks: get: description: Gets a list of Log Analytics QueryPacks within a resource group. operationId: microsoftAzureQuerypacksListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter responses: '200': description: A list containing 0 or more Log Analytics QueryPack definitions. schema: $ref: '#/definitions/LogAnalyticsQueryPackListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_4' x-ms-examples: QueryPackListByResourceGroup: $ref: ./examples/QueryPacksListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Querypacks tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName} : delete: description: Deletes a Log Analytics QueryPack. operationId: microsoftAzureQuerypacksDelete parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter_2' responses: '200': description: Successful request when deleting a Log Analytics QueryPack. '204': description: The specified QueryPack does not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_4' x-ms-examples: QueryPacksDelete: $ref: ./examples/QueryPacksDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Querypacks Querypackname tags: - Subscriptions get: description: Returns a Log Analytics QueryPack. operationId: microsoftAzureQuerypacksGet parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter_2' responses: '200': description: An Log Analytics QueryPack definition. schema: $ref: '#/definitions/LogAnalyticsQueryPack' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_4' x-ms-examples: QueryPackGet: $ref: ./examples/QueryPacksGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Querypacks Querypackname tags: - Subscriptions put: description: 'Creates (or updates) a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.' operationId: microsoftAzureQuerypacksCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter_2' - name: LogAnalyticsQueryPackPayload description: Properties that need to be specified to create or update a Log Analytics QueryPack. in: body required: true schema: $ref: '#/definitions/LogAnalyticsQueryPack' responses: '200': description: Successful request when creating or updating a Log Analytics QueryPack. The updated QueryPack is returned. schema: $ref: '#/definitions/LogAnalyticsQueryPack' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_4' x-ms-examples: QueryPackCreate: $ref: ./examples/QueryPacksCreate.json QueryPackUpdate: $ref: ./examples/QueryPacksUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Querypacks Querypackname tags: - Subscriptions patch: description: Updates an existing QueryPack's tags. To update other fields use the CreateOrUpdate method. operationId: microsoftAzureQuerypacksUpdatetags parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ResourceNameParameter_2' - name: QueryPackTags description: Updated tag information to set into the QueryPack instance. in: body required: true schema: $ref: '#/definitions/TagsResource_2' responses: '200': description: Updating the Log Analytics QueryPack's tags was successful. QueryPack tags are updated and returned with the rest of the QueryPack's object properties. schema: $ref: '#/definitions/LogAnalyticsQueryPack' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_4' x-ms-examples: QueryPackUpdateTagsOnly: $ref: ./examples/QueryPacksUpdateTagsOnly.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Querypacks Querypackname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies : get: summary: Microsoft Azure List Streaming Policies description: Lists the Streaming Policies in the account operationId: microsoftAzureStreamingpoliciesList responses: '200': description: OK schema: $ref: '#/definitions/StreamingPolicyCollection' default: description: Detailed error information. schema: $ref: '#/definitions/ApiError' parameters: - $ref: '#/parameters/SubscriptionId' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/MediaServicesAccountName' - $ref: '#/parameters/ApiVersion' - name: $filter in: query required: false type: string description: Restricts the set of items returned. - name: $top in: query required: false type: integer description: Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. - name: $orderby in: query required: false type: string description: Specifies the key by which the result collection should be ordered. x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-odata: '#/definitions/StreamingPolicy' x-ms-examples: Lists Streaming Policies: $ref: examples/streaming-policies-list.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies/{streamingPolicyName} : get: summary: Microsoft Azure Get A Streaming Policy description: Get the details of a Streaming Policy in the Media Services account operationId: microsoftAzureStreamingpoliciesGet responses: '200': description: OK schema: $ref: '#/definitions/StreamingPolicy' '404': description: NotFound default: description: Detailed error information. schema: $ref: '#/definitions/ApiError' parameters: - $ref: '#/parameters/SubscriptionId' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/MediaServicesAccountName' - name: streamingPolicyName in: path required: true type: string description: The Streaming Policy name. - $ref: '#/parameters/ApiVersion' x-ms-examples: Get a Streaming Policy by name: $ref: examples/streaming-policy-get-by-name.json tags: - Subscriptions put: summary: Microsoft Azure Create A Streaming Policy description: Create a Streaming Policy in the Media Services account operationId: microsoftAzureStreamingpoliciesCreate responses: '201': description: Created schema: $ref: '#/definitions/StreamingPolicy' default: description: Detailed error information. schema: $ref: '#/definitions/ApiError' parameters: - $ref: '#/parameters/SubscriptionId' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/MediaServicesAccountName' - name: streamingPolicyName in: path required: true type: string description: The Streaming Policy name. - name: parameters in: body required: true schema: $ref: '#/definitions/StreamingPolicy' description: The request parameters - $ref: '#/parameters/ApiVersion' x-ms-examples: Creates a Streaming Policy with clear streaming: $ref: examples/streaming-policies-create-clear.json Creates a Streaming Policy with envelopeEncryption only: $ref: examples/streaming-policies-create-envelopeEncryption-only.json Creates a Streaming Policy with commonEncryptionCenc only: $ref: examples/streaming-policies-create-commonEncryptionCenc-only.json Creates a Streaming Policy with commonEncryptionCbcs only: $ref: examples/streaming-policies-create-commonEncryptionCbcs-only.json Creates a Streaming Policy with secure streaming: $ref: examples/streaming-policies-create-secure-streaming.json tags: - Subscriptions delete: summary: Microsoft Azure Delete A Streaming Policy description: Deletes a Streaming Policy in the Media Services account operationId: microsoftAzureStreamingpoliciesDelete responses: '200': description: OK '204': description: NoContent default: description: Detailed error information. schema: $ref: '#/definitions/ApiError' parameters: - $ref: '#/parameters/SubscriptionId' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/MediaServicesAccountName' - name: streamingPolicyName in: path required: true type: string description: The Streaming Policy name. - $ref: '#/parameters/ApiVersion' x-ms-examples: Delete a Streaming Policy: $ref: examples/streaming-policies-delete.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators : get: summary: Microsoft Azure List Streaming Locators description: Lists the Streaming Locators in the account operationId: microsoftAzureStreaminglocatorsList responses: '200': description: OK schema: $ref: '#/definitions/StreamingLocatorCollection' default: description: Detailed error information. schema: $ref: '#/definitions/ApiError' parameters: - $ref: '#/parameters/SubscriptionId' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/MediaServicesAccountName' - $ref: '#/parameters/ApiVersion' - name: $filter in: query required: false type: string description: Restricts the set of items returned. - name: $top in: query required: false type: integer description: Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. - name: $orderby in: query required: false type: string description: Specifies the key by which the result collection should be ordered. x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-odata: '#/definitions/StreamingLocator' x-ms-examples: Lists Streaming Locators: $ref: examples/streaming-locators-list.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName} : get: summary: Microsoft Azure Get A Streaming Locator description: Get the details of a Streaming Locator in the Media Services account operationId: microsoftAzureStreaminglocatorsGet responses: '200': description: OK schema: $ref: '#/definitions/StreamingLocator' '404': description: NotFound default: description: Detailed error information. schema: $ref: '#/definitions/ApiError' parameters: - $ref: '#/parameters/SubscriptionId' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/MediaServicesAccountName' - name: streamingLocatorName in: path required: true type: string description: The Streaming Locator name. - $ref: '#/parameters/ApiVersion' x-ms-examples: Get a Streaming Locator by name: $ref: examples/streaming-locators-get-by-name.json tags: - Subscriptions put: summary: Microsoft Azure Create A Streaming Locator description: Create a Streaming Locator in the Media Services account operationId: microsoftAzureStreaminglocatorsCreate responses: '201': description: Created schema: $ref: '#/definitions/StreamingLocator' default: description: Detailed error information. schema: $ref: '#/definitions/ApiError' parameters: - $ref: '#/parameters/SubscriptionId' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/MediaServicesAccountName' - name: streamingLocatorName in: path required: true type: string description: The Streaming Locator name. - name: parameters in: body required: true schema: $ref: '#/definitions/StreamingLocator' description: The request parameters - $ref: '#/parameters/ApiVersion' x-ms-examples: Creates a Streaming Locator with clear streaming: $ref: examples/streaming-locators-create-clear.json Creates a Streaming Locator with secure streaming: $ref: examples/streaming-locators-create-secure.json Creates a Streaming Locator with user defined content keys: $ref: examples/streaming-locators-create-secure-userDefinedContentKeys.json tags: - Subscriptions delete: summary: Microsoft Azure Delete A Streaming Locator description: Deletes a Streaming Locator in the Media Services account operationId: microsoftAzureStreaminglocatorsDelete responses: '200': description: OK '204': description: NoContent default: description: Detailed error information. schema: $ref: '#/definitions/ApiError' parameters: - $ref: '#/parameters/SubscriptionId' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/MediaServicesAccountName' - name: streamingLocatorName in: path required: true type: string description: The Streaming Locator name. - $ref: '#/parameters/ApiVersion' x-ms-examples: Delete a Streaming Locator: $ref: examples/streaming-locators-delete.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listContentKeys : post: summary: Microsoft Azure List Content Keys description: List Content Keys used by this Streaming Locator operationId: microsoftAzureStreaminglocatorsListcontentkeys responses: '200': description: OK schema: $ref: '#/definitions/ListContentKeysResponse' default: description: Detailed error information. schema: $ref: '#/definitions/ApiError' parameters: - $ref: '#/parameters/SubscriptionId' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/MediaServicesAccountName' - name: streamingLocatorName in: path required: true type: string description: The Streaming Locator name. - $ref: '#/parameters/ApiVersion' x-ms-examples: List Content Keys: $ref: examples/streaming-locators-list-content-keys.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listPaths : post: summary: Microsoft Azure List Paths description: List Paths supported by this Streaming Locator operationId: microsoftAzureStreaminglocatorsListpaths responses: '200': description: OK schema: $ref: '#/definitions/ListPathsResponse' default: description: Detailed error information. schema: $ref: '#/definitions/ApiError' parameters: - $ref: '#/parameters/SubscriptionId' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/MediaServicesAccountName' - name: streamingLocatorName in: path required: true type: string description: The Streaming Locator name. - $ref: '#/parameters/ApiVersion' x-ms-examples: List Paths which has streaming paths only: $ref: examples/streaming-locators-list-paths-streaming-only.json List Paths which has streaming paths and download paths: $ref: examples/streaming-locators-list-paths-streaming-and-download.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Migrate/projects: get: summary: Microsoft Azure Get All Projects description: Get all the projects in the resource group. operationId: microsoftAzureProjectsList parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/api-version' - $ref: '#/parameters/acceptLanguage' responses: '200': description: OK. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/ProjectResultList' '401': description: Not authorized (No access to subscription or resource group). '404': description: Not found (Invalid subscriptionId, resourceGroupName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-pageable: nextLinkName: null x-ms-examples: Projects_List: $ref: ./examples/Projects_List.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}: get: summary: Microsoft Azure Get The Specified Project description: Get the project with the specified name. operationId: microsoftAzureProjectsGet parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/acceptLanguage' responses: '200': description: OK. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Project' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, projectName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Projects_Get: $ref: ./examples/Projects_Get.json tags: - Subscriptions put: summary: Microsoft Azure Create Or Update Project description: Create a project with specified name. If a project already exists, update it. operationId: microsoftAzureProjectsCreate parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/acceptLanguage' - name: project description: New or Updated project object. in: body schema: $ref: '#/definitions/Project' responses: '200': description: OK. Existing project updated. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Project' '201': description: Created. New project was created. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Project' '400': description: Bad Request (Read only settings of an existing project cannot be changed). '401': description: Not authorized (No access to subscription, resource group, or project). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Projects_Create: $ref: ./examples/Projects_Create.json tags: - Subscriptions patch: summary: Microsoft Azure Update Project description: Update a project with specified name. Supports partial updates, for example only tags can be provided. operationId: microsoftAzureProjectsUpdate parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/acceptLanguage' - name: project description: Updated project object. in: body schema: $ref: '#/definitions/Project' responses: '200': description: OK. Existing project updated. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Project' '400': description: Bad Request (Read only settings of an existing project cannot be changed). '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, or nestName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Projects_Update: $ref: ./examples/Projects_Update.json tags: - Subscriptions delete: summary: Microsoft Azure Delete The Project description: Delete the project. Deleting non-existent project is a no-operation. operationId: microsoftAzureProjectsDelete parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/acceptLanguage' responses: '200': description: OK. Deleted the group. headers: x-ms-request-id: type: string description: Service generated Request ID. '204': description: No content. No project with specified name was found. '400': description: Bad request. (Invalid subscriptionId or resourceGroupName). '401': description: Not authorized (No access to subscription, resource group, or project) '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Projects_Delete: $ref: ./examples/Projects_Delete.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/keys: post: summary: Microsoft Azure Get Shared Keys For The Project description: Gets the Log Analytics Workspace ID and Primary Key for the specified project. operationId: microsoftAzureProjectsGetkeys parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/acceptLanguage' responses: '200': description: OK. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/ProjectKey' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, projectName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Projects_GetKeys: $ref: ./examples/Projects_GetKeys.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/machines : get: summary: Microsoft Azure Get All Machines In The Project description: Get data of all the machines available in the project. Returns a json array of objects of type 'machine' defined in Models section. operationId: microsoftAzureMachinesListbyproject parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Returns list of all machine objects. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/MachineResultList' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, projectName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-pageable: nextLinkName: null x-ms-examples: Machines_ListByProject: $ref: ./examples/Machines_ListByProject.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/machines/{machineName} : get: summary: Microsoft Azure Get A Specific Machine description: Get the machine with the specified name. Returns a json object of type 'machine' defined in Models section. operationId: microsoftAzureMachinesGet parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/machineName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Returns the machine with the specified name. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Machine' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, projectName, or machineName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Machines_Get: $ref: ./examples/Machines_Get.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups : get: summary: Microsoft Azure Get All Groups description: Get all groups created in the project. Returns a json array of objects of type 'group' as specified in the Models section. operationId: microsoftAzureGroupsListbyproject parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Returns list of groups. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/GroupResultList' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, projectName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-pageable: nextLinkName: null x-ms-examples: Groups_ListByProject: $ref: ./examples/Groups_ListByProject.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName} : get: summary: Microsoft Azure Get A Specific Group description: Get information related to a specific group in the project. Returns a json object of type 'group' as specified in the models section. operationId: microsoftAzureGroupsGet parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/groupName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Returns the group with the specified name. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Group' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, projectName, or groupName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Groups_Get: $ref: ./examples/Groups_Get.json tags: - Subscriptions put: summary: Microsoft Azure Create A New Group With Specified Settings If Group With The Name Provided Already Exists, Then The Existing Group Is Updated description: Create a new group by sending a json object of type 'group' as given in Models section as part of the Request Body. The group name in a project is unique. Labels can be applied on a group as part of creation.

If a group with the groupName specified in the URL already exists, then this call acts as an update.

This operation is Idempotent.
operationId: microsoftAzureGroupsCreate parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/groupName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' - name: group description: New or Updated Group object. in: body schema: $ref: '#/definitions/Group' responses: '200': description: OK. Existing group updated. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Group' '201': description: Created. New group was created. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Group' '400': description: Bad Request (Read only settings of an existing group cannot be changed). '401': description: Not authorized (No access to subscription, resource group, or project). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Groups_Create: $ref: ./examples/Groups_Create.json tags: - Subscriptions delete: summary: Microsoft Azure Delete The Group description: Delete the group from the project. The machines remain in the project. Deleting a non-existent group results in a no-operation.

A group is an aggregation mechanism for machines in a project. Therefore, deleting group does not delete machines in it.
operationId: microsoftAzureGroupsDelete parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/groupName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Deleted the group. headers: x-ms-request-id: type: string description: Service generated Request ID. '204': description: No content. No group with specified name was found. '401': description: Not authorized (No access to subscription, resource group, or project) '404': description: Not found (Invalid subscriptionId, resourceGroupName) '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Groups_Delete: $ref: ./examples/Groups_Delete.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments : get: summary: Microsoft Azure Get All Assessments Created For The Specified Group description: Get all assessments created for the specified group.

Returns a json array of objects of type 'assessment' as specified in Models section.
operationId: microsoftAzureAssessmentsListbygroup parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/groupName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Returns list of Assessment objects. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/AssessmentResultList' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, assessmentName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-pageable: nextLinkName: null x-ms-examples: Assessments_ListByGroup: $ref: ./examples/Assessments_ListByGroup.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/assessments : get: summary: Microsoft Azure Get All Assessments Created In The Project description: Get all assessments created in the project.

Returns a json array of objects of type 'assessment' as specified in Models section.
operationId: microsoftAzureAssessmentsListbyproject parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Returns list of Assessment objects. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/AssessmentResultList' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, assessmentName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-pageable: nextLinkName: null x-ms-examples: Assessments_ListByProject: $ref: ./examples/Assessments_ListByProject.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName} : get: summary: Microsoft Azure Get An Assessment description: Get an existing assessment with the specified name. Returns a json object of type 'assessment' as specified in Models section. operationId: microsoftAzureAssessmentsGet parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/groupName' - $ref: '#/parameters/assessmentName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Returns Assessment object. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Assessment' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, projectName, or assessmentName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Assessments_Get: $ref: ./examples/Assessments_Get.json tags: - Subscriptions put: summary: Microsoft Azure Create Or Update Assessment description: Create a new assessment with the given name and the specified settings. Since name of an assessment in a project is a unique identifier, if an assessment with the name provided already exists, then the existing assessment is updated.

Any PUT operation, resulting in either create or update on an assessment, will cause the assessment to go in a "InProgress" state. This will be indicated by the field 'computationState' on the Assessment object. During this time no other PUT operation will be allowed on that assessment object, nor will a Delete operation. Once the computation for the assessment is complete, the field 'computationState' will be updated to 'Ready', and then other PUT or DELETE operations can happen on the assessment.

When assessment is under computation, any PUT will lead to a 400 - Bad Request error.
operationId: microsoftAzureAssessmentsCreate parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/groupName' - $ref: '#/parameters/assessmentName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' - name: assessment description: New or Updated Assessment object. in: body schema: $ref: '#/definitions/Assessment' responses: '200': description: OK. Existing assessment updated. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Assessment' '201': description: Created. New assessment was created. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/Assessment' '400': description: Bad Request. Assessment is under computation and cannot be updated yet. '401': description: Not authorized (No access to subscription, resource group, or project). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Assessments_Create: $ref: ./examples/Assessments_Create.json tags: - Subscriptions delete: summary: Microsoft Azure Deletes An Assessment From The Project description: Delete an assessment from the project. The machines remain in the assessment. Deleting a non-existent assessment results in a no-operation.

When an assessment is under computation, as indicated by the 'computationState' field, it cannot be deleted. Any such attempt will return a 400 - Bad Request.
operationId: microsoftAzureAssessmentsDelete parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/groupName' - $ref: '#/parameters/assessmentName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Deleted the assessment. headers: x-ms-request-id: type: string description: Service generated Request ID. '204': description: No content. No assessment with specified name was found. '400': description: Bad Request. Assessment is under computation and cannot be deleted yet. '401': description: Not authorized (No access to subscription, resource group, or project) '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Assessments_Delete: $ref: ./examples/Assessments_Delete.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}/downloadUrl : post: summary: Microsoft Azure Get Download Url For The Assessment Report description: Get the URL for downloading the assessment in a report format. operationId: microsoftAzureAssessmentsGetreportdownloadurl parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/groupName' - $ref: '#/parameters/assessmentName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/acceptLanguage' responses: '200': description: OK. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/DownloadUrl' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, projectName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: Assessments_GetReportDownloadUrl: $ref: ./examples/Assessments_GetReportDownloadUrl.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines : get: summary: Microsoft Azure Get Assessed Machines For Assessment description: Get list of machines that assessed as part of the specified assessment. Returns a json array of objects of type 'assessedMachine' as specified in the Models section.

Whenever an assessment is created or updated, it goes under computation. During this phase, the 'status' field of Assessment object reports 'Computing'.
During the period when the assessment is under computation, the list of assessed machines is empty and no assessed machines are returned by this call.
operationId: microsoftAzureAssessedmachinesListbyassessment parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/groupName' - $ref: '#/parameters/assessmentName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Returns list of machines with their assessment data in the assessment. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/AssessedMachineResultList' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, projectName, or assessmentName). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-pageable: nextLinkName: null x-ms-examples: AssessedMachines_ListByAssessment: $ref: ./examples/AssessedMachines_ListByAssessment.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName} : get: summary: Microsoft Azure Get An Assessed Machine description: Get an assessed machine with its size & cost estimate that was evaluated in the specified assessment. operationId: microsoftAzureAssessedmachinesGet parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - $ref: '#/parameters/projectName' - $ref: '#/parameters/groupName' - $ref: '#/parameters/assessmentName' - $ref: '#/parameters/assessedMachineName' - $ref: '#/parameters/acceptLanguage' - $ref: '#/parameters/api-version' responses: '200': description: OK. Returns a specific assessed machine. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/AssessedMachine' '401': description: Not authorized (No access to subscription, resource group, or project). '404': description: Not found (Invalid subscriptionId, resourceGroupName, projectName, groupName, assessmentName, or machineId). '500': description: Internal Server Error. '503': description: Service Unavailable. x-ms-examples: AssessedMachines_Get: $ref: ./examples/AssessedMachines_Get.json tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Migrate/migrateProjects: get: summary: Microsoft Azure Get All Migrate Projects description: Get all the migrate projects in the subscription. operationId: microsoftAzureProjectsListbysubscription parameters: - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/ProjectResultList_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Projects_ListBySubscription_MaximumSet_Gen: $ref: ./examples/Projects_ListBySubscription_MaximumSet_Gen.json Projects_ListBySubscription_MinimumSet_Gen: $ref: ./examples/Projects_ListBySubscription_MinimumSet_Gen.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects: get: summary: Microsoft Azure Get All Migrate Projects description: Get all the migrate projects in the resource group. operationId: microsoftAzureProjectsList parameters: - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. headers: x-ms-request-id: type: string description: Service generated Request ID. schema: $ref: '#/definitions/ProjectResultList_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Projects_List_MaximumSet_Gen: $ref: ./examples/Projects_List_MaximumSet_Gen.json Projects_List_MinimumSet_Gen: $ref: ./examples/Projects_List_MinimumSet_Gen.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}: get: description: Returns the Workspace resource associated with the given name. operationId: microsoftAzureWorkspacesGet x-ms-examples: QuantumWorkspacesGet: $ref: ./examples/quantumWorkspacesGet.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/WorkspaceNameParameter' responses: '200': description: Workspace details. schema: $ref: '#/definitions/QuantumWorkspace' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename tags: - Subscriptions put: description: Creates or updates a workspace resource. operationId: microsoftAzureWorkspacesCreateorupdate x-ms-examples: QuantumWorkspacesPut: $ref: ./examples/quantumWorkspacesPut.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/WorkspaceNameParameter' - name: QuantumWorkspace description: Workspace details. in: body required: true schema: $ref: '#/definitions/QuantumWorkspace' responses: '200': description: Successful. schema: $ref: '#/definitions/QuantumWorkspace' '201': description: Workspace create/update request accepted. schema: $ref: '#/definitions/QuantumWorkspace' 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 summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename tags: - Subscriptions patch: description: Updates an existing workspace's tags. operationId: microsoftAzureWorkspacesUpdatetags x-ms-examples: QuantumWorkspacesPatchTags: $ref: ./examples/quantumWorkspacesPatch.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/WorkspaceNameParameter' - name: workspaceTags in: body required: true schema: $ref: '#/definitions/TagsObject' description: Parameters supplied to update tags. responses: '200': description: Successful. schema: $ref: '#/definitions/QuantumWorkspace' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename tags: - Subscriptions delete: description: Deletes a Workspace resource. operationId: microsoftAzureWorkspacesDelete x-ms-examples: QuantumWorkspacesDelete: $ref: ./examples/quantumWorkspacesDelete.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/WorkspaceNameParameter' responses: '200': description: Successful. '202': description: Workspace delete request accepted. '204': description: No content - The workspace doesn't exist. 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 summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Quantum/workspaces: get: operationId: microsoftAzureWorkspacesListbysubscription x-ms-examples: QuantumWorkspacesListBySubscription: $ref: ./examples/quantumWorkspacesListSubscription.json description: Gets the list of Workspaces within a Subscription. parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' responses: '200': description: Workspaces successfully returned. schema: $ref: '#/definitions/WorkspaceListResult' 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 summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Quantum Workspaces tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces: get: operationId: microsoftAzureWorkspacesListbyresourcegroup x-ms-examples: QuantumWorkspacesListByResourceGroup: $ref: ./examples/quantumWorkspacesListResourceGroup.json description: Gets the list of Workspaces within a resource group. parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' responses: '200': description: Workspaces successfully returned. schema: $ref: '#/definitions/WorkspaceListResult' 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 summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/offerings: get: description: Returns the list of all provider offerings available for the given location. operationId: microsoftAzureOfferingsList x-ms-examples: OfferingsList: $ref: ./examples/offeringsList.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/LocationParameter' responses: '200': description: Offerings details. schema: $ref: '#/definitions/OfferingsListResult' 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 summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Quantum Locations Locationname Offerings tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/checkNameAvailability: post: description: Check the availability of the resource name. operationId: microsoftAzureWorkspaceChecknameavailability x-ms-examples: QuantumWorkspacesCheckNameAvailability: $ref: ./examples/quantumWorkspacesCheckNameAvailability.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/LocationParameter' - name: checkNameAvailabilityParameters in: body required: true schema: $ref: '#/definitions/CheckNameAvailabilityParameters' description: The name and type of the resource. responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/CheckNameAvailabilityResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse deprecated: false summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Quantum Locations Locationname Checknameavailability tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs : get: operationId: microsoftAzureJobsList description: List all jobs. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedJobDetails' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: List jobs in a workspace.: $ref: ./examples/Jobs_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Jobs tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId} : get: operationId: microsoftAzureJobsGet description: Get job by its id. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client - name: jobId in: path description: Id of the job. required: true type: string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/JobDetails' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Gets a job by its id.: $ref: ./examples/Jobs_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Jobs Jobid tags: - Subscriptions put: operationId: microsoftAzureJobsCreate description: Create a new job. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client - name: jobId in: path description: Id of the job. required: true type: string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ - name: resource in: body description: The resource instance. required: true schema: $ref: '#/definitions/JobDetails' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/JobDetails' '201': description: The request has succeeded and a new resource has been created as a result. schema: $ref: '#/definitions/JobDetails' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Creates a job.: $ref: ./examples/Jobs_Create.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Jobs Jobid tags: - Subscriptions patch: operationId: microsoftAzureJobsUpdate description: Update job properties. consumes: - application/json-patch+json parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client - name: jobId in: path description: Id of the job. required: true type: string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ - name: resource in: body description: The resource instance. required: true schema: $ref: '#/definitions/JsonPatchDocument' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/JobDetails' '204': description: There is no content to send for this request, but the headers may be useful. default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Patches a job.: $ref: ./examples/Jobs_Update.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Jobs Jobid tags: - Subscriptions delete: operationId: microsoftAzureJobsCancel description: Request the cancellation of an existing job. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client - name: jobId in: path description: Id of the job. required: true type: string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Cancels a job.: $ref: ./examples/Jobs_Cancel.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Jobs Jobid tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/providerStatus : get: operationId: microsoftAzureProvidersList description: List all providers in the workspace with their respective status. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedProviderStatus' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Get provider and target statuses.: $ref: ./examples/Providers_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Providerstatus tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas : get: operationId: microsoftAzureQuotasList description: List quotas for the given workspace. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedQuota' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Get workspace quotas.: $ref: ./examples/Quotas_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Quotas tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions : get: operationId: microsoftAzureSessionsList description: List all Sessions. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedSessionDetails' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: List sessions in a workspace.: $ref: ./examples/Sessions_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Sessions tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId} : get: operationId: microsoftAzureSessionsGet description: Get Session by its id. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client - name: sessionId in: path description: Id of the session. required: true type: string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/SessionDetails' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Get a session by its id.: $ref: ./examples/Sessions_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Sessions Sessionid tags: - Subscriptions put: operationId: microsoftAzureSessionsOpen description: Open a new session. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client - name: sessionId in: path description: Id of the session. required: true type: string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ - name: resource in: body description: The resource instance. required: true schema: $ref: '#/definitions/SessionDetails' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/SessionDetails' '201': description: The request has succeeded and a new resource has been created as a result. schema: $ref: '#/definitions/SessionDetails' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Open a session.: $ref: ./examples/Sessions_Open.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Sessions Sessionid tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}:close : post: operationId: microsoftAzureSessionsClose description: Close an existing session. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client - name: sessionId in: path description: Id of the session. required: true type: string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/SessionDetails' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Closes a session by its id.: $ref: ./examples/Sessions_Close.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Sessions Sessionid:close tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}/jobs : get: operationId: microsoftAzureSessionsjobsList description: List jobs in a session. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client - name: sessionId in: path description: Id of the session to list jobs from. required: true type: string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedJobDetails' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: List jobs in a workspace.: $ref: ./examples/SessionsJobs_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Sessions Sessionid Jobs tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/storage/sasUri : post: operationId: microsoftAzureStorageGetsasuri description: Gets a URL with SAS token for a container/blob in the storage account associated with the workspace. The SAS URL can be used to upload job input and/or download job output. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - $ref: '#/parameters/CommonParams.subscriptionId' - $ref: '#/parameters/CommonParams.resourceGroupName' - $ref: '#/parameters/CommonParams.workspaceName' - name: blobDetails in: body description: The details (name and container) of the blob. required: true schema: $ref: '#/definitions/BlobDetails' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/SasUriResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Gets a URL with SAS token for a container/blob.: $ref: ./examples/Storage_GetSasUri.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Storage Sasuri tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/topLevelItems : get: operationId: microsoftAzureToplevelitemsList description: List top-level items. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client - name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client - name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedItemDetails' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: List top level items in a workspace.: $ref: ./examples/TopLevelItems_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Quantum Workspaces Workspacename Toplevelitems tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceGraph/queries/{resourceName} : patch: description: Updates a graph query that has already been added. operationId: microsoftAzureGraphqueryUpdate parameters: - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/GraphQueryResourceNameParameter' - $ref: '#/parameters/ApiVersionParameter_3' - name: body description: Properties that need to be specified to create a new graph query. in: body required: true schema: $ref: '#/definitions/GraphQueryUpdateParameters' responses: '200': description: The graph query definition updated. schema: $ref: '#/definitions/GraphQueryResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/GraphQueryError' x-ms-examples: Update Graph Query: $ref: ./examples/GraphQueryUpdate.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resourcegraph Queries Resourcename tags: - Subscriptions /subscriptions: get: operationId: Subscriptions_List summary: Microsoft Azure List All Subscriptions description: Gets all subscriptions for the authenticated tenant. tags: - Subscriptions parameters: - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully returned the list of subscriptions. content: application/json: schema: $ref: '#/components/schemas/SubscriptionListResult' examples: SubscriptionsList200Example: summary: Default Subscriptions_List 200 response x-microcks-default: true value: value: - id: abc123 subscriptionId: '500123' displayName: example_value tenantId: '500123' state: Enabled authorizationSource: example_value tags: example_value nextLink: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: SubscriptionsListdefaultExample: summary: Default Subscriptions_List default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - {} additionalInfo: - {} x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}: get: operationId: Subscriptions_Get summary: Microsoft Azure Get a Subscription description: Gets details about the specified subscription. tags: - Subscriptions parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully returned the subscription details. content: application/json: schema: $ref: '#/components/schemas/Subscription' examples: SubscriptionsGet200Example: summary: Default Subscriptions_Get 200 response x-microcks-default: true value: id: abc123 subscriptionId: '500123' displayName: example_value tenantId: '500123' state: Enabled subscriptionPolicies: locationPlacementId: '500123' quotaId: '500123' spendingLimit: 'On' authorizationSource: example_value tags: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: SubscriptionsGetdefaultExample: summary: Default Subscriptions_Get default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - {} additionalInfo: - {} x-microcks-operation: delay: 0 dispatcher: FALLBACK put: x-ms-examples: Create or updates a subscription: $ref: ./examples/Subscriptions/Create.json description: Create or updates a subscription. tags: - Subscriptions operationId: microsoftAzureSubscriptionsCreateorupdate parameters: - $ref: '#/parameters/SubscriptionIdParameter_17' - $ref: '#/parameters/SubscriptionDefinitionParameter' - $ref: '#/parameters/ApiVersionParameter_16' responses: '200': description: OK schema: $ref: '#/definitions/Subscription' '201': description: Created schema: $ref: '#/definitions/Subscription' summary: Microsoft Azure Put Subscriptions Subscriptionid delete: x-ms-examples: Delete the specified subscription: $ref: ./examples/Subscriptions/Delete.json description: Delete the specified subscription. tags: - Subscriptions operationId: microsoftAzureSubscriptionsDelete parameters: - $ref: '#/parameters/SubscriptionIdParameter_17' - $ref: '#/parameters/ApiVersionParameter_16' responses: '200': description: OK '204': description: No Content produces: - application/json consumes: - application/json summary: Microsoft Azure Delete Subscriptions Subscriptionid /subscriptions/{subscriptionId}/tagNames: get: operationId: Tags_List summary: Microsoft Azure List Predefined Tag Names description: Gets a summary of tag usage under the subscription. This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags. tags: - Subscriptions parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully returned the tag names. content: application/json: schema: $ref: '#/components/schemas/TagsListResult' examples: TagsList200Example: summary: Default Tags_List 200 response x-microcks-default: true value: value: - id: abc123 tagName: example_value values: {} nextLink: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: TagsListdefaultExample: summary: Default Tags_List default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - {} additionalInfo: - {} x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers: get: summary: Microsoft Azure List Video Analyzer Accounts description: Lists the Video Analyzer accounts in the specified resource group. operationId: microsoftAzureVideoanalyzersList responses: '200': description: OK schema: $ref: '#/definitions/VideoAnalyzerCollection' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: List all Video Analyzer accounts: $ref: examples/video-analyzer-accounts-list-all-accounts.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}: get: summary: Microsoft Azure Get A Video Analyzer Account description: Get the details of the specified Video Analyzer account operationId: microsoftAzureVideoanalyzersGet responses: '200': description: OK schema: $ref: '#/definitions/VideoAnalyzer' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Get a Video Analyzer account by name: $ref: examples/video-analyzer-accounts-get-by-name.json tags: - Subscriptions put: summary: Microsoft Azure Create Or Update A Video Analyzer Account description: Create or update an instance of a Video Analyzer account operationId: microsoftAzureVideoanalyzersCreateorupdate responses: '200': description: OK schema: $ref: '#/definitions/VideoAnalyzer' '201': description: Created headers: Retry-After: description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. type: integer format: int32 Location: description: The URI to poll for completion status. type: string Azure-AsyncOperation: description: The URI to poll for completion status. type: string schema: $ref: '#/definitions/VideoAnalyzer' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - name: parameters in: body required: true schema: $ref: '#/definitions/VideoAnalyzer' description: The request parameters - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-long-running-operation: true x-ms-examples: Create a Video Analyzer account: $ref: examples/video-analyzer-accounts-create-or-update.json tags: - Subscriptions delete: summary: Microsoft Azure Delete A Video Analyzer Account description: Delete the specified Video Analyzer account operationId: microsoftAzureVideoanalyzersDelete responses: '200': description: OK '204': description: NoContent default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Delete a Video Analyzer account: $ref: examples/video-analyzer-accounts-delete.json tags: - Subscriptions patch: summary: Microsoft Azure Update A Video Analyzer Account description: Updates an existing instance of Video Analyzer account operationId: microsoftAzureVideoanalyzersUpdate responses: '202': description: Accepted headers: Retry-After: description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. type: integer format: int32 Location: description: The URI to poll for completion status. type: string Azure-AsyncOperation: description: The URI to poll for completion status. type: string schema: $ref: '#/definitions/VideoAnalyzer' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - name: parameters in: body required: true schema: $ref: '#/definitions/VideoAnalyzerUpdate' description: The request parameters - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-long-running-operation: true x-ms-examples: Update a Video Analyzer accounts: $ref: examples/video-analyzer-accounts-update.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateLinkResources : get: summary: Microsoft Azure Get List Of Group Ids description: Get list of group IDs for video analyzer account. operationId: microsoftAzurePrivatelinkresourcesList responses: '200': description: OK schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Get list of all group IDs.: $ref: examples/video-analyzer-private-link-resources-list.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateLinkResources/{name} : get: summary: Microsoft Azure Get Group Id description: Get group ID for video analyzer account. operationId: microsoftAzurePrivatelinkresourcesGet responses: '200': description: OK schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkResource default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - name: name in: path required: true type: string description: Name of the private link resource (Group ID). - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Get details of a group ID.: $ref: examples/video-analyzer-private-link-resources-get-by-name.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateEndpointConnections : get: summary: Microsoft Azure Get All Private Endpoint Connections description: Get all private endpoint connections under video analyzer account. operationId: microsoftAzurePrivateendpointconnectionsList responses: '200': description: OK schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Get all private endpoint connections.: $ref: examples/video-analyzer-private-endpoint-connection-list.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateEndpointConnections/{name} : get: summary: Microsoft Azure Get Private Endpoint Connection description: Get private endpoint connection under video analyzer account. operationId: microsoftAzurePrivateendpointconnectionsGet responses: '200': description: OK schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - name: name in: path required: true type: string description: Private endpoint connection name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Get private endpoint connection.: $ref: examples/video-analyzer-private-endpoint-connection-get-by-name.json tags: - Subscriptions put: summary: Microsoft Azure Update Private Endpoint Connection description: Update private endpoint connection state under video analyzer account. operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate responses: '201': description: Created headers: Retry-After: description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. type: integer format: int32 Location: description: The URI to poll for completion status. type: string Azure-AsyncOperation: description: The URI to poll for completion status. type: string schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - name: name in: path required: true type: string description: Private endpoint connection name. - name: parameters in: body required: true schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection description: The request parameters - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Update private endpoint connection.: $ref: examples/video-analyzer-private-endpoint-connection-put.json tags: - Subscriptions delete: summary: Microsoft Azure Delete Private Endpoint Connection description: Delete private endpoint connection under video analyzer account. operationId: microsoftAzurePrivateendpointconnectionsDelete responses: '200': description: OK '204': description: NoContent default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - name: name in: path required: true type: string description: Private endpoint connection name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Delete private endpoint connection.: $ref: examples/video-analyzer-private-endpoint-connection-delete.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateEndpointConnections/{name}/operationStatuses/{operationId} : get: summary: Microsoft Azure Get Operation Status description: Get private endpoint connection operation status. operationId: microsoftAzureOperationstatusesGet responses: '200': description: OK schema: $ref: '#/definitions/VideoAnalyzerPrivateEndpointConnectionOperationStatus' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - name: name in: path required: true type: string description: Private endpoint connection name. - name: operationId in: path required: true type: string description: Operation Id. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Get status of private endpoint asynchronous operation when it is completed.: $ref: examples/video-analyzer-private-endpoint-connection-operation-status-by-id-terminal-state.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateEndpointConnections/{name}/operationResults/{operationId} : get: summary: Microsoft Azure Get Operation Result description: Get private endpoint connection operation result. operationId: microsoftAzureOperationresultsGet responses: '200': description: OK schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection '202': description: Accepted default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: accountName in: path required: true type: string description: The Video Analyzer account name. - name: name in: path required: true type: string description: Private endpoint connection name. - name: operationId in: path required: true type: string description: Operation Id. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Get status of private endpoint connection asynchronous operation.: $ref: examples/video-analyzer-private-endpoint-connection-operation-result-by-id.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/videoAnalyzerOperationStatuses/{operationId} : get: summary: Microsoft Azure Get Operation Status description: Get video analyzer operation status. operationId: microsoftAzureVideoanalyzeroperationstatusesGet responses: '200': description: OK schema: $ref: '#/definitions/VideoAnalyzerOperationStatus' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - name: locationName in: path required: true type: string description: Location name. - name: operationId in: path required: true type: string description: Operation Id. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Get status of asynchronous operation when it is completed.: $ref: examples/video-analyzer-operation-status-by-id-terminal-state.json Get status of asynchronous operation when it is ongoing.: $ref: examples/video-analyzer-operation-status-by-id-non-terminal-state.json Get status of asynchronous operation when it is completed with error.: $ref: examples/video-analyzer-operation-status-by-id-non-terminal-state-failed.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/videoAnalyzerOperationResults/{operationId} : get: summary: Microsoft Azure Get Operation Result description: Get video analyzer operation result. operationId: microsoftAzureVideoanalyzeroperationresultsGet responses: '200': description: OK schema: $ref: '#/definitions/VideoAnalyzer' '202': description: Accepted default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - name: locationName in: path required: true type: string description: Location name. - name: operationId in: path required: true type: string description: Operation Id. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Get status of asynchronous operation.: $ref: examples/video-analyzer-operation-result-by-id.json tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/checkNameAvailability: post: summary: Microsoft Azure Check Name Availability description: Checks whether the Video Analyzer resource name is available. operationId: microsoftAzureLocationsChecknameavailability responses: '200': description: OK schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - name: locationName in: path required: true type: string description: Location Name. - name: parameters in: body required: true schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest description: The request parameters - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Check Name Availability: $ref: examples/accounts-check-name-availability.json tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Media/videoAnalyzers: get: summary: Microsoft Azure List Video Analyzer Accounts description: List all Video Analyzer accounts in the specified subscription. operationId: microsoftAzureVideoanalyzersListbysubscription responses: '200': description: OK schema: $ref: '#/definitions/VideoAnalyzerCollection' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: List all Video Analyzer accounts in the specified subscription: $ref: examples/video-analyzer-accounts-subscription-list-all-accounts.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos : get: summary: Microsoft Azure Retrieves All Existing Video Resources description: Retrieves a list of video resources that have been created, along with their JSON representations. operationId: microsoftAzureVideosList responses: '200': description: OK schema: $ref: '#/definitions/VideoEntityCollection' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: $top in: query required: false type: integer format: int32 description: Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. x-ms-pageable: nextLinkName: '@nextLink' x-ms-examples: Lists video entities.: $ref: examples/video-list.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos/{videoName} : get: summary: Microsoft Azure Retrieves An Existing Video Resource description: Retrieves an existing video resource with the given name. operationId: microsoftAzureVideosGet responses: '200': description: OK schema: $ref: '#/definitions/VideoEntity' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - name: videoName in: path required: true type: string description: The Video name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Gets a video entity.: $ref: examples/video-get.json tags: - Subscriptions put: summary: Microsoft Azure Creates A New Video Resource Or Updates An Existing One description: Creates a new video resource or updates an existing video resource with the given name. operationId: microsoftAzureVideosCreateorupdate responses: '200': description: OK schema: $ref: '#/definitions/VideoEntity' '201': description: Created schema: $ref: '#/definitions/VideoEntity' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - name: videoName in: path required: true type: string description: The Video name. - name: parameters in: body required: true schema: $ref: '#/definitions/VideoEntity' description: The request parameters - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Register video entity.: $ref: examples/video-create.json tags: - Subscriptions delete: summary: Microsoft Azure Deletes An Existing Video Resource And Its Underlying Data description: Deletes an existing video resource and its underlying data. This operation is irreversible. operationId: microsoftAzureVideosDelete responses: '200': description: OK '204': description: NoContent default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - name: videoName in: path required: true type: string description: The Video name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Deletes a video entity.: $ref: examples/video-delete.json tags: - Subscriptions patch: summary: Microsoft Azure Updates Individual Properties Of An Existing Video Resource description: Updates individual properties of an existing video resource with the given name. operationId: microsoftAzureVideosUpdate responses: '200': description: OK schema: $ref: '#/definitions/VideoEntity' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - name: videoName in: path required: true type: string description: The Video name. - name: parameters in: body required: true schema: $ref: '#/definitions/VideoEntity' description: The request parameters - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Update video entity.: $ref: examples/video-patch.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos/{videoName}/listContentToken : post: summary: Microsoft Azure Generates A Streaming Token Which Can Be Used For Accessing Content From Video Content Urls description: Generates a streaming token which can be used for accessing content from video content URLs, for a video resource with the given name. operationId: microsoftAzureVideosListcontenttoken responses: '200': description: OK schema: $ref: '#/definitions/VideoContentToken' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - name: videoName in: path required: true type: string description: The Video name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Generate a content token for media endpoint authorization.: $ref: examples/video-listContentToken.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/accessPolicies : get: summary: Microsoft Azure List All Existing Access Policy Resources description: Retrieves all existing access policy resources, along with their JSON representations. operationId: microsoftAzureAccesspoliciesList responses: '200': description: OK schema: $ref: '#/definitions/AccessPolicyEntityCollection' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: $top in: query required: false type: integer format: int32 description: Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. x-ms-pageable: nextLinkName: '@nextLink' x-ms-examples: Lists access policy entities.: $ref: examples/access-policy-list.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/accessPolicies/{accessPolicyName} : get: summary: Microsoft Azure Retrieves An Existing Access Policy Resource description: Retrieves an existing access policy resource with the given name. operationId: microsoftAzureAccesspoliciesGet responses: '200': description: OK schema: $ref: '#/definitions/AccessPolicyEntity' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - name: accessPolicyName in: path required: true type: string description: The Access Policy name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Gets an access policy entity.: $ref: examples/access-policy-get.json tags: - Subscriptions put: summary: Microsoft Azure Creates A New Access Policy Resource Or Updates An Existing One description: Creates a new access policy resource or updates an existing one with the given name. operationId: microsoftAzureAccesspoliciesCreateorupdate responses: '200': description: OK schema: $ref: '#/definitions/AccessPolicyEntity' '201': description: Created schema: $ref: '#/definitions/AccessPolicyEntity' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - name: accessPolicyName in: path required: true type: string description: The Access Policy name. - name: parameters in: body required: true schema: $ref: '#/definitions/AccessPolicyEntity' description: The request parameters - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Register access policy entity.: $ref: examples/access-policy-create.json tags: - Subscriptions delete: summary: Microsoft Azure Deletes An Existing Access Policy Resource description: Deletes an existing access policy resource with the given name. operationId: microsoftAzureAccesspoliciesDelete responses: '200': description: OK '204': description: NoContent default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - name: accessPolicyName in: path required: true type: string description: The Access Policy name. - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Deletes an access policy entity.: $ref: examples/access-policy-delete.json tags: - Subscriptions patch: summary: Microsoft Azure Updates Individual Properties Of An Existing Access Policy Resource description: Updates individual properties of an existing access policy resource with the given name. operationId: microsoftAzureAccesspoliciesUpdate responses: '200': description: OK schema: $ref: '#/definitions/AccessPolicyEntity' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureVideoAnalyzerAccountName' - name: accessPolicyName in: path required: true type: string description: The Access Policy name. - name: parameters in: body required: true schema: $ref: '#/definitions/AccessPolicyEntity' description: The request parameters - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: Update access policy entity.: $ref: examples/access-policy-patch.json tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/skus: get: description: Lists eligible SKUs for Analysis Services resource provider. x-ms-examples: List eligible SKUs for a new server: $ref: ./examples/listSkusForNew.json operationId: microsoftAzureServersListskusfornew parameters: - $ref: '#/parameters/ApiVersionParameter_4' - $ref: '#/parameters/SubscriptionIdParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/SkuEnumerationForNewResourceResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_5' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Analysisservices Skus tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName} : get: description: Gets flow resource. x-ms-examples: Gets flow resource: $ref: examples/getFlow.json operationId: microsoftAzureFlowsGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: '#/parameters/flowNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Retrieved the flows resource. schema: $ref: '#/definitions/flow' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Flows Flowname tags: - Subscriptions put: description: Creates or updates the flow resource. operationId: microsoftAzureFlowsCreateorupdate x-ms-examples: Creates or updates the flow resource: $ref: examples/createOrUpdateFlow.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: '#/parameters/flowNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: flow description: Flow body in: body required: true schema: $ref: '#/definitions/flow' responses: '200': description: Created the flows resource. schema: $ref: '#/definitions/flow' '201': description: Accepted creation the flows resource. schema: $ref: '#/definitions/flow' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Flows Flowname tags: - Subscriptions delete: description: Deletes the flow resource. x-ms-examples: Deletes the flow resource: $ref: examples/deleteFlow.json operationId: microsoftAzureFlowsDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: '#/parameters/flowNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '202': description: Accepted delete the flows resource. headers: location: description: Location response header type: string '204': description: Deleted the flows resource. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Flows Flowname tags: - Subscriptions patch: description: Updates the flow resource. operationId: microsoftAzureFlowsUpdate x-ms-examples: Updates the flow resource: $ref: examples/patchFlow.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: '#/parameters/flowNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: flow description: Flow body in: body required: true schema: $ref: '#/definitions/flowsPatch' responses: '200': description: Updated the flows resource. schema: $ref: '#/definitions/flow' '202': description: Accepted update to the flows resource. headers: location: description: Location response header type: string schema: $ref: '#/definitions/flow' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Flows Flowname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/enable : post: description: Enables the specified flow. x-ms-examples: Enables the specified flow: $ref: examples/enableOrDisableFlow.json operationId: microsoftAzureFlowsEnable parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: '#/parameters/flowNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Enables a flow. schema: $ref: '#/definitions/flow' '202': description: Enables a flow. headers: location: description: Location response header type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Flows Flowname Enable tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/disable : post: description: Disables the specified flow x-ms-examples: Disables the specified flow: $ref: examples/enableOrDisableFlow.json operationId: microsoftAzureFlowsDisable parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: '#/parameters/flowNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Disables a flow. schema: $ref: '#/definitions/flow' '202': description: Disables a flow. headers: location: description: Location response header type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Flows Flowname Disable tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/link : post: description: Links the specified flow. x-ms-examples: Links the specified flow: $ref: examples/linkFlow.json operationId: microsoftAzureFlowsLink parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: '#/parameters/flowNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: flow description: Flow body in: body required: true schema: $ref: '#/definitions/resourceBody' responses: '200': description: Links a flow. schema: $ref: '#/definitions/flow' '202': description: Links a flow. headers: location: description: Location response header type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Flows Flowname Link tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows : get: description: Gets flows in a connection. x-ms-examples: Gets flows in a connection: $ref: examples/listFlowsByConnection.json operationId: microsoftAzureFlowsListbyconnection parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/connectionNameParameter' responses: '200': description: Listed all flows under the resource group. schema: $ref: '#/definitions/flowsListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Flows tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName} : get: description: Gets connection resource. x-ms-examples: Gets connection resource: $ref: examples/getConnection.json operationId: microsoftAzureConnectionsGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Retrieved the connections resource. schema: $ref: '#/definitions/connection' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname tags: - Subscriptions put: description: Creates or updates the connection resource. operationId: microsoftAzureConnectionsCreateorupdate x-ms-examples: Creates or updates the connection resource: $ref: examples/createOrUpdateConnection.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: connection description: Connection body in: body required: true schema: $ref: '#/definitions/connection' responses: '200': description: Created the connections resource. schema: $ref: '#/definitions/connection' '201': description: Accepted create of the connections resource. schema: $ref: '#/definitions/connection' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname tags: - Subscriptions delete: description: Deletes the connection resource. x-ms-examples: Deletes the connection resource: $ref: examples/deleteConnection.json operationId: microsoftAzureConnectionsDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '202': description: Accepted delete the connections resource. headers: location: description: Location response header type: string '204': description: Deleted the connections resource. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname tags: - Subscriptions patch: description: Updates the connection resource. operationId: microsoftAzureConnectionsUpdate x-ms-examples: Updates the connection resource: $ref: examples/patchConnection.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: connection description: Connection body in: body required: true schema: $ref: '#/definitions/connectionsPatch' responses: '200': description: Updated the connections resource. schema: $ref: '#/definitions/connection' '202': description: Accepted update to the connections resource. headers: location: description: Location response header type: string schema: $ref: '#/definitions/connection' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/link : post: description: Links the connection to its pending connection. x-ms-examples: Links the specified connection: $ref: examples/linkConnection.json operationId: microsoftAzureConnectionsLink parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: connection description: Connection body in: body required: true schema: $ref: '#/definitions/resourceBody' responses: '200': description: Links a connection. schema: $ref: '#/definitions/connection' '202': description: Links a connection. headers: location: description: Location response header type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Link tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingConnections : post: description: Lists all pending connections for a connection. x-ms-examples: Lists a list of pending connections: $ref: examples/listPendingConnections.json operationId: microsoftAzureListpendingconnectionsList parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Listed all pending connections. schema: $ref: '#/definitions/pendingConnectionsListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Listpendingconnections tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingFlows : post: description: Lists all pending flows for a connection. x-ms-examples: Lists a list of pending flows: $ref: examples/listPendingFlows.json operationId: microsoftAzureListpendingflowsList parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/connectionNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Listed all connections under the resource group. schema: $ref: '#/definitions/pendingFlowsListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections Connectionname Listpendingflows tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections: get: description: Gets connections in a resource group. x-ms-examples: Gets connections in a resource group: $ref: examples/listConnectionsByResourceGroup.json operationId: microsoftAzureConnectionsListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Listed all connections under the resource group. schema: $ref: '#/definitions/connectionsListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Connections tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/connections: get: description: Gets connections in a subscription. x-ms-examples: Gets connections in a subscription: $ref: examples/listConnectionsBySubscription.json operationId: microsoftAzureConnectionsListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Listed all connections under the subscription. schema: $ref: '#/definitions/connectionsListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Get Subscriptions Subscriptionid Providers Microsoft Azuredatatransfer Connections tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName} : get: description: Gets pipeline resource. x-ms-examples: Gets pipeline resource: $ref: examples/getPipeline.json operationId: microsoftAzurePipelinesGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/pipelineNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Retrieved the pipelines resource. schema: $ref: '#/definitions/pipeline' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Pipelines Pipelinename tags: - Subscriptions put: description: Creates or updates the pipeline resource. operationId: microsoftAzurePipelinesCreateorupdate x-ms-examples: Creates or updates the pipeline resource: $ref: examples/createOrUpdatePipeline.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/pipelineNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: pipeline description: Pipeline body in: body required: true schema: $ref: '#/definitions/pipeline' responses: '200': description: Created the pipelines resource. schema: $ref: '#/definitions/pipeline' '201': description: Accepted create of the pipelines resource. schema: $ref: '#/definitions/pipeline' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Pipelines Pipelinename tags: - Subscriptions delete: description: Deletes the pipeline resource. x-ms-examples: Deletes the pipeline resource: $ref: examples/deletePipeline.json operationId: microsoftAzurePipelinesDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/pipelineNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '202': description: Accepted delete of the pipelines resource. headers: location: description: Location response header type: string '204': description: Deleted the pipelines resource. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Pipelines Pipelinename tags: - Subscriptions patch: description: Updates the pipeline resource. operationId: microsoftAzurePipelinesUpdate x-ms-examples: Updates the pipeline resource: $ref: examples/patchPipeline.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/pipelineNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: pipeline description: Pipeline body in: body required: true schema: $ref: '#/definitions/pipelinesPatch' responses: '200': description: Updated the pipelines resource. schema: $ref: '#/definitions/pipeline' '202': description: Accepted update to the pipelines resource. headers: location: description: Location response header type: string schema: $ref: '#/definitions/pipeline' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Pipelines Pipelinename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/approveConnection : post: description: Approves the specified connection in a pipeline. x-ms-examples: Approves the specified connection in a pipeline: $ref: examples/approveOrRejectConnection.json operationId: microsoftAzurePipelinesApproveconnection parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/pipelineNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: connection description: Connection body in: body required: true schema: $ref: '#/definitions/resourceBody' responses: '200': description: Approves a connection. schema: $ref: '#/definitions/connection' '202': description: Approves a connection. headers: location: description: Location response header type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Pipelines Pipelinename Approveconnection tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/rejectConnection : post: description: Rejects the specified connection in a pipeline. x-ms-examples: Rejects the specified connection in a pipeline: $ref: examples/approveOrRejectConnection.json operationId: microsoftAzurePipelinesRejectconnection parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/pipelineNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: connection description: Connection body in: body required: true schema: $ref: '#/definitions/resourceBody' responses: '200': description: Rejects a connection. schema: $ref: '#/definitions/connection' '202': description: Rejects a connection. headers: location: description: Location response header type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Pipelines Pipelinename Rejectconnection tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listSchemas : post: description: Lists the schemas for the specified connection in a pipeline. x-ms-examples: Lists schemas for a pipeline: $ref: examples/listSchemas.json operationId: microsoftAzureListschemasList parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/pipelineNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: schema description: Schema(s) to retrieve in: body required: true schema: $ref: '#/definitions/schema' responses: '200': description: Approves a connection. schema: description: The schemas for this connection $ref: '#/definitions/schemasListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Pipelines Pipelinename Listschemas tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines: get: description: Gets pipelines in a resource group. x-ms-examples: Gets pipelines in a resource group: $ref: examples/listPipelinesByResourceGroup.json operationId: microsoftAzurePipelinesListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Listed all pipelines under the resource group. schema: $ref: '#/definitions/pipelinesListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredatatransfer Pipelines tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/pipelines: get: description: Gets pipelines in a subscription. x-ms-examples: Gets pipelines in a subscription: $ref: examples/listPipelinesBySubscription.json operationId: microsoftAzurePipelinesListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Listed all pipelines under the subscription. schema: $ref: '#/definitions/pipelinesListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Get Subscriptions Subscriptionid Providers Microsoft Azuredatatransfer Pipelines tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/apply : post: operationId: microsoftAzureUpdatesPost description: Apply Update parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/UpdateNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: ACCEPTED headers: Azure-AsyncOperation: description: URL to query for status of the operation. type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: List available updates: $ref: ./examples/PostUpdates.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azurestackhci Clusters Clustername Updates Updatename Apply tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates : get: operationId: microsoftAzureUpdatesList description: List all Updates parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/UpdateList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: List available updates: $ref: ./examples/ListUpdates.json x-ms-pageable: nextLinkName: nextLink summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azurestackhci Clusters Clustername Updates tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName} : delete: operationId: microsoftAzureUpdatesDelete description: Delete specified Update parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/UpdateNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: ACCEPTED headers: Azure-AsyncOperation: description: URL to query for status of the operation. type: string '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/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 an Update: $ref: ./examples/DeleteUpdates.json summary: Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azurestackhci Clusters Clustername Updates Updatename tags: - Subscriptions put: operationId: microsoftAzureUpdatesPut description: Put specified Update parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/UpdateNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: updateProperties in: body description: Properties of the Updates object required: true schema: $ref: '#/definitions/Update' responses: '200': description: OK schema: $ref: '#/definitions/Update' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Put a specific update: $ref: ./examples/PutUpdates.json summary: Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azurestackhci Clusters Clustername Updates Updatename tags: - Subscriptions get: operationId: microsoftAzureUpdatesGet description: Get specified Update parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/UpdateNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/Update' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Get a specific update: $ref: ./examples/GetUpdates.json summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azurestackhci Clusters Clustername Updates Updatename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/start : post: description: The operation to start an AzureBareMetal instance operationId: microsoftAzureAzurebaremetalinstancesStart x-ms-long-running-operation: true x-ms-examples: Start an AzureBareMetal instance: $ref: ./examples/AzureBareMetalInstances_Start.json consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureBareMetalInstanceNameParameter' responses: '200': description: OK '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Baremetalinfrastructure Baremetalinstances Azurebaremetalinstancename Start tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/restart : post: description: The operation to restart an AzureBareMetal instance operationId: microsoftAzureAzurebaremetalinstancesRestart x-ms-long-running-operation: true x-ms-examples: Restart an AzureBareMetal instance: $ref: ./examples/AzureBareMetalInstances_Restart.json consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureBareMetalInstanceNameParameter' responses: '200': description: OK '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Baremetalinfrastructure Baremetalinstances Azurebaremetalinstancename Restart tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/shutdown : post: description: The operation to shutdown an AzureBareMetal instance operationId: microsoftAzureAzurebaremetalinstancesShutdown x-ms-long-running-operation: true x-ms-examples: Shutdown an AzureBareMetal instance: $ref: ./examples/AzureBareMetalInstances_Shutdown.json consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureBareMetalInstanceNameParameter' responses: '200': description: OK '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Baremetalinfrastructure Baremetalinstances Azurebaremetalinstancename Shutdown tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances : get: operationId: microsoftAzureAzurebaremetalinstancesList description: Gets a list of AzureBareMetal instances in the specified subscription and resource group x-ms-examples: List all AzureBareMetal instances in a resource group: $ref: ./examples/AzureBareMetalInstances_List.json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/AzureBareMetalInstancesListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Baremetalinfrastructure Baremetalinstances tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability: post: operationId: microsoftAzureLocationChecknameavailability description: Checks whether the Batch account name is available in the specified region. x-ms-examples: LocationCheckNameAvailability_Available: $ref: ./examples/LocationCheckNameAvailability_Available.json LocationCheckNameAvailability_AlreadyExists: $ref: ./examples/LocationCheckNameAvailability_AlreadyExists.json parameters: - name: locationName in: path required: true type: string description: The desired region for the name check. - $ref: '#/parameters/ApiVersionParameter_5' - $ref: '#/parameters/SubscriptionIdParameter_5' - name: parameters in: body required: true schema: $ref: '#/definitions/CheckNameAvailabilityParameters_2' description: Properties needed to check the availability of a name. responses: '200': description: Success. Returns details about whether a Batch account name is available. schema: $ref: '#/definitions/CheckNameAvailabilityResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Batch Locations Locationname Checknameavailability tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors : get: operationId: microsoftAzureBatchaccountListdetectors description: Gets information about the detectors available for a given Batch account. x-ms-examples: ListDetectors: $ref: ./examples/DetectorList.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/ApiVersionParameter_6' - $ref: '#/parameters/SubscriptionIdParameter_6' - $ref: '#/parameters/AccountNameParameter' responses: '200': description: The operation was successful. The response contains a list of detectors associated with a Batch account. schema: $ref: '#/definitions/DetectorListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Detectors tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors/{detectorId} : get: operationId: microsoftAzureBatchaccountGetdetector description: Gets information about the given detector for a given Batch account. x-ms-examples: GetDetector: $ref: ./examples/DetectorGet.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/ApiVersionParameter_6' - $ref: '#/parameters/SubscriptionIdParameter_6' - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/DetectorIdParameter' responses: '200': description: The operation was successful. The response contains information about the given detector associated with a Batch account. schema: $ref: '#/definitions/DetectorResponse' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Detectors Detectorid tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions: post: operationId: microsoftAzurePolicyrestrictionsCheckatsubscriptionscope description: Checks what restrictions Azure Policy will place on a resource within a subscription. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/CheckRestrictionsRequest' description: The check policy restrictions parameters. responses: '200': description: The restrictions that will be placed on the resource by Azure Policy. schema: $ref: '#/definitions/CheckRestrictionsResult' default: description: Error response describing why the operation failed. schema: $ref: ../../stable/2019-10-01/policyMetadata.json#/definitions/ErrorResponse x-ms-examples: Check policy restrictions at subscription scope: $ref: ./examples/PolicyRestrictions_CheckAtSubscriptionScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Policyinsights Checkpolicyrestrictions tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions : post: operationId: microsoftAzurePolicyrestrictionsCheckatresourcegroupscope description: Checks what restrictions Azure Policy will place on a resource within a resource group. Use this when the resource group the resource will be created in is already known. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/CheckRestrictionsRequest' description: The check policy restrictions parameters. responses: '200': description: The restrictions that will be placed on the resource by Azure Policy. schema: $ref: '#/definitions/CheckRestrictionsResult' default: description: Error response describing why the operation failed. schema: $ref: ../../stable/2019-10-01/policyMetadata.json#/definitions/ErrorResponse x-ms-examples: Check policy restrictions at resource group scope: $ref: ./examples/PolicyRestrictions_CheckAtResourceGroupScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Checkpolicyrestrictions tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults : post: operationId: microsoftAzureComponentpolicystatesListqueryresultsforsubscription description: Queries component policy states under subscription scope. parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/componentPolicyStatesResource' - $ref: '#/parameters/apiVersion_2' - $ref: '#/parameters/top' - $ref: '#/parameters/orderBy' - $ref: '#/parameters/select' - $ref: '#/parameters/from' - $ref: '#/parameters/to' - $ref: '#/parameters/filter' - $ref: '#/parameters/apply' responses: '200': description: Query results. schema: $ref: '#/definitions/ComponentPolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: ../../stable/2019-10-01/policyMetadata.json#/definitions/ErrorResponse x-ms-examples: Query latest component policy states at subscription scope: $ref: ./examples/ComponentPolicyStates_QuerySubscriptionScope.json ? Query latest component policy compliance state count grouped by component type at subscription scope filtered by given assignment. : $ref: ./examples/ComponentPolicyStates_QuerySubscriptionScopeGroupByComponentTypeWithAggregate.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Policyinsights Componentpolicystates Componentpolicystatesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults : post: operationId: microsoftAzureComponentpolicystatesListqueryresultsforresourcegroup description: Queries component policy states under resource group scope. parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/resourceGroupName_3' - $ref: '#/parameters/componentPolicyStatesResource' - $ref: '#/parameters/apiVersion_2' - $ref: '#/parameters/top' - $ref: '#/parameters/orderBy' - $ref: '#/parameters/select' - $ref: '#/parameters/from' - $ref: '#/parameters/to' - $ref: '#/parameters/filter' - $ref: '#/parameters/apply' responses: '200': description: Query results. schema: $ref: '#/definitions/ComponentPolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: ../../stable/2019-10-01/policyMetadata.json#/definitions/ErrorResponse x-ms-examples: Query latest component policy states at resource group scope: $ref: ./examples/ComponentPolicyStates_QueryResourceGroupScope.json ? Query latest component policy compliance state count grouped by component type at resource group scope filtered by given assignment. : $ref: ./examples/ComponentPolicyStates_QueryResourceGroupScopeGroupByComponentTypeWithAggregate.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Componentpolicystates Componentpolicystatesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults : post: operationId: microsoftAzureComponentpolicystatesListqueryresultsforpolicydefinition description: Queries component policy states for the subscription level policy definition. parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/authorizationNamespace' - $ref: '#/parameters/policyDefinitionName' - $ref: '#/parameters/componentPolicyStatesResource' - $ref: '#/parameters/apiVersion_2' - $ref: '#/parameters/top' - $ref: '#/parameters/orderBy' - $ref: '#/parameters/select' - $ref: '#/parameters/from' - $ref: '#/parameters/to' - $ref: '#/parameters/filter' - $ref: '#/parameters/apply' responses: '200': description: Query results. schema: $ref: '#/definitions/ComponentPolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: ../../stable/2019-10-01/policyMetadata.json#/definitions/ErrorResponse x-ms-examples: Query latest component policy states at subscription level policy definition scope: $ref: ./examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policydefinitions Policydefinitionname Providers Microsoft Policyinsights Componentpolicystates Componentpolicystatesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults : post: operationId: microsoftAzureComponentpolicystatesListqueryresultsforsubscriptionlevelpolicyassignment description: Queries component policy states for the subscription level policy assignment. parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/authorizationNamespace' - $ref: '#/parameters/policyAssignmentName' - $ref: '#/parameters/componentPolicyStatesResource' - $ref: '#/parameters/apiVersion_2' - $ref: '#/parameters/top' - $ref: '#/parameters/orderBy' - $ref: '#/parameters/select' - $ref: '#/parameters/from' - $ref: '#/parameters/to' - $ref: '#/parameters/filter' - $ref: '#/parameters/apply' responses: '200': description: Query results. schema: $ref: '#/definitions/ComponentPolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: ../../stable/2019-10-01/policyMetadata.json#/definitions/ErrorResponse x-ms-examples: Query latest at subscription level policy assignment scope: $ref: ./examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policyassignments Policyassignmentname Providers Microsoft Policyinsights Componentpolicystates Componentpolicystatesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults : post: operationId: microsoftAzureComponentpolicystatesListqueryresultsforresourcegrouplevelpolicyassignment description: Queries component policy states for the resource group level policy assignment. parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/resourceGroupName_3' - $ref: '#/parameters/authorizationNamespace' - $ref: '#/parameters/policyAssignmentName' - $ref: '#/parameters/componentPolicyStatesResource' - $ref: '#/parameters/apiVersion_2' - $ref: '#/parameters/top' - $ref: '#/parameters/orderBy' - $ref: '#/parameters/select' - $ref: '#/parameters/from' - $ref: '#/parameters/to' - $ref: '#/parameters/filter' - $ref: '#/parameters/apply' responses: '200': description: Query results. schema: $ref: '#/definitions/ComponentPolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: ../../stable/2019-10-01/policyMetadata.json#/definitions/ErrorResponse x-ms-examples: Query latest at resource group level policy assignment scope: $ref: ./examples/ComponentPolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Authorizationnamespace Policyassignments Policyassignmentname Providers Microsoft Policyinsights Componentpolicystates Componentpolicystatesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName} : put: summary: Microsoft Azure Register A New Kubernetes Cluster With Azure Resource Manager operationId: microsoftAzureConnectedclusterCreate description: API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM). consumes: - application/json produces: - application/json x-ms-examples: CreateClusterExample: $ref: ./examples/CreateClusterExample.json CreateCluster_KindExample: $ref: ./examples/CreateCluster_KindExample.json CreateClusterPrivateLinkExample: $ref: ./examples/CreateClusterPrivateLinkExample.json 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/ClusterNamePathParam' - in: body name: ConnectedCluster required: true schema: $ref: '#/definitions/ConnectedCluster' description: Parameters supplied to Create a Connected Cluster. responses: '200': description: OK schema: $ref: '#/definitions/ConnectedCluster' '201': description: Resource creation request accepted schema: $ref: '#/definitions/ConnectedCluster' default: description: Resource Provider 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 tags: - Subscriptions patch: summary: Microsoft Azure Updates A Connected Cluster operationId: microsoftAzureConnectedclusterUpdate description: API to update certain properties of the connected cluster resource consumes: - application/json produces: - application/json x-ms-examples: UpdateClusterExample: $ref: ./examples/UpdateClusterExample.json 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/ClusterNamePathParam' - in: body name: ConnectedClusterPatch required: true schema: $ref: '#/definitions/ConnectedClusterPatch' description: Parameters supplied to update Connected Cluster. responses: '200': description: OK schema: $ref: '#/definitions/ConnectedCluster' default: description: Resource Provider error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse tags: - Subscriptions get: summary: Microsoft Azure Get The Properties Of The Specified Connected Cluster operationId: microsoftAzureConnectedclusterGet description: Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details. produces: - application/json x-ms-examples: GetClusterExample: $ref: ./examples/GetClusterExample.json GetProvisionedClusterExample: $ref: ./examples/GetProvisionedClusterExample.json 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/ClusterNamePathParam' responses: '200': description: Resource retrieved successfully. schema: $ref: '#/definitions/ConnectedCluster' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse tags: - Subscriptions delete: summary: Microsoft Azure Delete A Connected Cluster operationId: microsoftAzureConnectedclusterDelete description: Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM). produces: - application/json x-ms-examples: DeleteClusterExample: $ref: ./examples/DeleteClusterExample.json 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/ClusterNamePathParam' responses: '200': description: OK '202': description: Resource deletion is in progress '204': description: The resource was not found but the request is well formed default: description: Resource Provider 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: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}/listClusterUserCredential : post: summary: Microsoft Azure Gets Cluster User Credentials Of A Connected Cluster operationId: microsoftAzureConnectedclusterListclusterusercredential description: Gets cluster user credentials of the connected cluster with a specified resource group and name. produces: - application/json x-ms-examples: ListClusterUserCredentialExample: $ref: ./examples/ConnectedClustersListClusterCredentialResultCSPAAD.json ListClusterUserCredentialNonAadExample: $ref: ./examples/ConnectedClustersListClusterCredentialResultCSPToken.json ListClusterUserCredentialCSPExample: $ref: ./examples/ConnectedClustersListClusterCredentialResultHPAAD.json ListClusterUserCredentialNonAadCSPExample: $ref: ./examples/ConnectedClustersListClusterCredentialResultHPToken.json 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/ClusterNamePathParam' - in: body required: true name: Properties schema: $ref: '#/definitions/ListClusterUserCredentialProperties' description: ListClusterUserCredential properties responses: '200': description: OK schema: $ref: '#/definitions/CredentialResults' default: description: Resource Provider error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse tags: - Subscriptions /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters: get: summary: Microsoft Azure Lists All Connected Clusters operationId: microsoftAzureConnectedclusterListbyresourcegroup description: API to enumerate registered connected K8s clusters under a Resource Group produces: - application/json x-ms-examples: GetClustersExample: $ref: ./examples/GetClustersByResourceGroupExample.json 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/ConnectedClusterList' default: description: Resource Provider error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Kubernetes/connectedClusters: get: summary: Microsoft Azure Lists All Connected Clusters operationId: microsoftAzureConnectedclusterListbysubscription description: API to enumerate registered connected K8s clusters under a Subscription produces: - application/json x-ms-examples: GetClustersBySubscriptionExample: $ref: ./examples/GetClustersBySubscriptionExample.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/ConnectedClusterList' default: description: Resource Provider error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups: get: operationId: microsoftAzureContainergroupsList x-ms-examples: ContainerGroupsList: $ref: ./examples/ContainerGroupsList.json summary: Microsoft Azure Get A List Of Container Groups In The Specified Subscription description: Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' responses: '200': description: OK schema: $ref: '#/definitions/ContainerGroupListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups: get: operationId: microsoftAzureContainergroupsListbyresourcegroup x-ms-examples: ContainerGroupsListByResourceGroup: $ref: ./examples/ContainerGroupsListByResourceGroup.json summary: Microsoft Azure Get A List Of Container Groups In The Specified Subscription And Resource Group description: Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/ContainerGroupListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName} : get: operationId: microsoftAzureContainergroupsGet x-ms-examples: ContainerGroupsGet_Succeeded: $ref: ./examples/ContainerGroupsGet_Succeeded.json ContainerGroupsGet_Failed: $ref: ./examples/ContainerGroupsGet_Failed.json summary: Microsoft Azure Get The Properties Of The Specified Container Group description: Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/ContainerGroup' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' tags: - Subscriptions put: operationId: microsoftAzureContainergroupsCreateorupdate x-ms-examples: ContainerGroupsCreateOrUpdate: $ref: ./examples/ContainerGroupsCreateOrUpdate.json ContainerGroupCreateWithExtensions: $ref: ./examples/ContainerGroupExtensions.json ContainerGroupWithEncryptionProperties: $ref: ./examples/ContainerGroupEncryptionProperties.json summary: Microsoft Azure Create Or Update Container Groups description: Create or update container groups with specified configurations. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' - name: containerGroup description: The properties of the container group to be created or updated. required: true in: body schema: $ref: '#/definitions/ContainerGroup' responses: '200': description: OK schema: $ref: '#/definitions/ContainerGroup' '201': description: Created - the container group is created. schema: $ref: '#/definitions/ContainerGroup' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true tags: - Subscriptions patch: operationId: microsoftAzureContainergroupsUpdate x-ms-examples: ContainerGroupsUpdate: $ref: ./examples/ContainerGroupsUpdate.json summary: Microsoft Azure Update Container Groups description: Updates container group tags with specified values. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' - name: Resource description: The container group resource with just the tags to be updated. required: true in: body schema: $ref: '#/definitions/Resource_3' responses: '200': description: OK schema: $ref: '#/definitions/ContainerGroup' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' tags: - Subscriptions delete: operationId: microsoftAzureContainergroupsDelete x-ms-examples: ContainerGroupsDelete: $ref: ./examples/ContainerGroupsDelete.json summary: Microsoft Azure Delete The Specified Container Group description: Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/ContainerGroup' '202': description: Delete started. '204': description: No Content - the specified container group was not found. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart : post: operationId: microsoftAzureContainergroupsRestart x-ms-examples: ContainerRestart: $ref: ./examples/ContainerGroupsRestart.json summary: Microsoft Azure Restarts All Containers In A Container Group description: Restarts all containers in a container group in place. If container image has updates, new image will be downloaded. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' responses: '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop : post: operationId: microsoftAzureContainergroupsStop x-ms-examples: ContainerStop: $ref: ./examples/ContainerGroupsStop.json summary: Microsoft Azure Stops All Containers In A Container Group description: Stops all containers in a container group. Compute resources will be deallocated and billing will stop. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' responses: '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start : post: operationId: microsoftAzureContainergroupsStart x-ms-examples: ContainerStart: $ref: ./examples/ContainerGroupsStart.json summary: Microsoft Azure Starts All Containers In A Container Group description: Starts all containers in a container group. Compute resources will be allocated and billing will start. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' responses: '202': description: Started - the container group is starting. '204': description: Started - the container group is already running or starting. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages: get: operationId: microsoftAzureLocationListusage x-ms-examples: ContainerUsage: $ref: ./examples/ContainerGroupUsage.json description: Get the usage for a subscription parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/LocationParameter_2' - $ref: '#/parameters/ApiVersionParameter_7' responses: '200': description: OK schema: $ref: '#/definitions/UsageListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Containerinstance Locations Location Usages tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs : get: operationId: microsoftAzureContainersListlogs x-ms-examples: ContainerListLogs: $ref: ./examples/ContainerListLogs.json summary: Microsoft Azure Get The Logs For A Specified Container Instance description: Get the logs for a specified container instance in a specified resource group and container group. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' - name: containerName in: path description: The name of the container instance. required: true type: string - name: tail in: query description: The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb. type: integer format: int32 - name: timestamps in: query description: If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false. type: boolean responses: '200': description: OK schema: $ref: '#/definitions/Logs' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec : post: operationId: microsoftAzureContainersExecutecommand x-ms-examples: ContainerExec: $ref: ./examples/ContainerExec.json summary: Microsoft Azure Executes A Command In A Specific Container Instance description: Executes a command for a specific container instance in a specified resource group and container group. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' - name: containerName in: path description: The name of the container instance. required: true type: string - name: containerExecRequest in: body description: The request for the exec command. required: true schema: $ref: '#/definitions/ContainerExecRequest' responses: '200': description: OK schema: $ref: '#/definitions/ContainerExecResponse' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach : post: operationId: microsoftAzureContainersAttach x-ms-examples: ContainerAttach: $ref: ./examples/ContainerAttach.json summary: Microsoft Azure Attach To The Output Of A Specific Container Instance description: Attach to the output stream of a specific container instance in a specified resource group and container group. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' - name: containerName in: path description: The name of the container instance. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/ContainerAttachResponse' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages: get: operationId: microsoftAzureLocationListcachedimages x-ms-examples: CachedImages: $ref: ./examples/CachedImagesList.json summary: Microsoft Azure Get The List Of Cached Images description: Get the list of cached images on specific OS type for a subscription in a region. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/LocationParameter_2' - $ref: '#/parameters/ApiVersionParameter_7' responses: '200': description: OK schema: $ref: '#/definitions/CachedImagesListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities: get: operationId: microsoftAzureLocationListcapabilities x-ms-examples: GetCapabilities: $ref: ./examples/CapabilitiesList.json summary: Microsoft Azure Get The List Of Capabilities Of The Location description: Get the list of CPU/memory/GPU capabilities of a region. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/LocationParameter_2' - $ref: '#/parameters/ApiVersionParameter_7' responses: '200': description: OK schema: $ref: '#/definitions/CapabilitiesListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints : get: operationId: microsoftAzureContainergroupsGetoutboundnetworkdependenciesendpoints x-ms-examples: {} summary: Microsoft Azure Get All Network Dependencies For Container Group description: Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ContainerGroupNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/NetworkDependenciesResponse' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/providers/Microsoft.ContainerInstance/serviceAssociationLinks/default : delete: operationId: microsoftAzureSubnetserviceassociationlinkDelete x-ms-examples: SubnetServiceAssociationLinkDelete: $ref: ./examples/SubnetServiceAssociationLinkDelete.json summary: Microsoft Azure Delete Container Group Virtual Network Association Links description: Delete container group virtual network association links. The operation does not delete other resources provided by the user. parameters: - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/VirtualNetworkNameParameter' - $ref: '#/parameters/SubnetNameParameter' responses: '200': description: OK '202': description: Delete started. '204': description: No Content - the specified container group was not found. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/cassandraClusters: get: operationId: microsoftAzureCassandraclustersListbysubscription description: List all managed Cassandra clusters in this subscription. x-ms-pageable: nextLinkName: null x-ms-examples: CosmosDBManagedCassandraClusterListBySubscription: $ref: ./examples/CosmosDBManagedCassandraClusterListBySubscription.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Successfully retrieved the list of managed Cassandra clusters. schema: $ref: '#/definitions/ListClusters' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Documentdb Cassandraclusters tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters: get: operationId: microsoftAzureCassandraclustersListbyresourcegroup description: List all managed Cassandra clusters in this resource group. x-ms-pageable: nextLinkName: null x-ms-examples: CosmosDBManagedCassandraClusterListByResourceGroup: $ref: ./examples/CosmosDBManagedCassandraClusterListByResourceGroup.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Successfully retrieved the list of managed Cassandra clusters. schema: $ref: '#/definitions/ListClusters' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName} : get: operationId: microsoftAzureCassandraclustersGet description: Get the properties of a managed Cassandra cluster. x-ms-examples: CosmosDBManagedCassandraClusterGet: $ref: ./examples/CosmosDBManagedCassandraClusterGet.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: The properties of the managed Cassandra cluster were retrieved successfully. schema: $ref: '#/definitions/ClusterResource' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername tags: - Subscriptions delete: operationId: microsoftAzureCassandraclustersDelete description: Deletes a managed Cassandra cluster. x-ms-long-running-operation: true x-ms-examples: CosmosDBManagedCassandraClusterDelete: $ref: ./examples/CosmosDBManagedCassandraClusterDelete.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '202': description: Accepted. The managed Cassandra cluster will be deleted asynchronously. '204': description: No such cluster to delete. default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername tags: - Subscriptions put: operationId: microsoftAzureCassandraclustersCreateupdate description: Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH. x-ms-examples: CosmosDBManagedCassandraClusterCreate: $ref: ./examples/CosmosDBManagedCassandraClusterCreate.json x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: body in: body required: true schema: $ref: '#/definitions/ClusterResource' description: The properties specifying the desired state of the managed Cassandra cluster. responses: '200': description: The managed Cassandra cluster is being updated. Poll for provisioningState=Succeeded to find when creation completes. schema: $ref: '#/definitions/ClusterResource' '201': description: The managed Cassandra cluster is being created. Poll for provisioningState=Succeeded to find when creation completes. schema: $ref: '#/definitions/ClusterResource' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername tags: - Subscriptions patch: operationId: microsoftAzureCassandraclustersUpdate description: Updates some of the properties of a managed Cassandra cluster. x-ms-long-running-operation: true x-ms-examples: CosmosDBManagedCassandraClusterPatch: $ref: ./examples/CosmosDBManagedCassandraClusterPatch.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: body in: body required: true schema: $ref: '#/definitions/ClusterResource' description: Parameters to provide for specifying the managed Cassandra cluster. responses: '200': description: Completed synchronously. This will only happen if the fields changed by patch require no changes to the actual Cassandra data center. schema: $ref: '#/definitions/ClusterResource' '202': description: The managed Cassandra cluster is being updated. Poll the provided operation for completion. schema: $ref: '#/definitions/ClusterResource' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/invokeCommand : post: operationId: microsoftAzureCassandraclustersInvokecommand description: 'Invoke a command like nodetool for cassandra maintenance ' x-ms-examples: CosmosDBManagedCassandraCommand: $ref: ./examples/CosmosDBManagedCassandraCommand.json x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: body in: body required: true schema: $ref: '#/definitions/CommandPostBody' description: Specification which command to run where responses: '202': description: Success. The command operation will begin as soon as possible. schema: $ref: '#/definitions/CommandOutput' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Invokecommand tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/invokeCommandAsync : post: operationId: microsoftAzureCassandraclustersInvokecommandasync description: Invoke a command like nodetool for cassandra maintenance asynchronously x-ms-examples: CosmosDBManagedCassandraCommandAsync: $ref: ./examples/CosmosDBManagedCassandraCommandAsync.json x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: body in: body required: true schema: $ref: '#/definitions/CommandPostBody' description: Specification which command to run where responses: '200': description: The command operation was completed successfully. schema: $ref: '#/definitions/CommandPublicResource' '202': description: Success. The command operation will begin as soon as possible. headers: azure-AsyncOperation: type: string description: URI to poll for completion status. location: type: string description: URI to poll for completion status. default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Invokecommandasync tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands : get: operationId: microsoftAzureCassandraclustersListcommand description: List all commands currently running on ring info x-ms-pageable: nextLinkName: null x-ms-examples: CosmosDBManagedCassandraListCommand: $ref: ./examples/CosmosDBManagedCassandraListCommand.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Successfully retrieved the list of shell commands. schema: $ref: '#/definitions/ListCommands' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Commands tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/commands/{commandId} : get: operationId: microsoftAzureCassandraclustersGetcommandasync description: Get details about a specified command that was run asynchronously. x-ms-examples: CosmosDBManagedCassandraCommandResult: $ref: ./examples/CosmosDBManagedCassandraCommandResult.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: '#/parameters/commandId' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. Return a command resource. schema: $ref: '#/definitions/ListCommands' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Commands Commandid tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups : get: operationId: microsoftAzureCassandraclustersListbackups description: List the backups of this cluster that are available to restore. x-ms-pageable: nextLinkName: null x-ms-examples: CosmosDBManagedCassandraBackupsList: $ref: ./examples/CosmosDBManagedCassandraBackupsList.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Successfully retrieved the list of restorable backups for this Cassandra cluster. schema: $ref: '#/definitions/ListBackups' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Backups tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups/{backupId} : get: operationId: microsoftAzureCassandraclustersGetbackup description: Get the properties of an individual backup of this cluster that is available to restore. x-ms-examples: CosmosDBManagedCassandraBackup: $ref: ./examples/CosmosDBManagedCassandraBackup.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: '#/parameters/backupNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Successfully retrieved the properties of the backup. schema: $ref: '#/definitions/BackupResource' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Backups Backupid tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters : get: operationId: microsoftAzureCassandradatacentersList description: List all data centers in a particular managed Cassandra cluster. x-ms-pageable: nextLinkName: null x-ms-examples: CosmosDBManagedCassandraDataCenterList: $ref: ./examples/CosmosDBManagedCassandraDataCenterList.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Successfully retrieved the list of managed Cassandra data centers. schema: $ref: '#/definitions/ListDataCenters' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Datacenters tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName} : get: operationId: microsoftAzureCassandradatacentersGet description: Get the properties of a managed Cassandra data center. x-ms-examples: CosmosDBManagedCassandraDataCenterGet: $ref: ./examples/CosmosDBManagedCassandraDataCenterGet.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: '#/parameters/dataCenterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: The properties of the managed Cassandra data center were retrieved successfully. schema: $ref: '#/definitions/DataCenterResource' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Datacenters Datacentername tags: - Subscriptions delete: operationId: microsoftAzureCassandradatacentersDelete description: Delete a managed Cassandra data center. x-ms-examples: CosmosDBManagedCassandraDataCenterDelete: $ref: ./examples/CosmosDBManagedCassandraDataCenterDelete.json x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: '#/parameters/dataCenterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '202': description: Accepted. Deletion will complete asynchronously. '204': description: Cassandra cluster with the specified name does not exist. default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Datacenters Datacentername tags: - Subscriptions put: operationId: microsoftAzureCassandradatacentersCreateupdate description: Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH. x-ms-examples: CosmosDBManagedCassandraDataCenterCreate: $ref: ./examples/CosmosDBManagedCassandraDataCenterCreate.json x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: '#/parameters/dataCenterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: body in: body required: true schema: $ref: '#/definitions/DataCenterResource' description: Parameters specifying the managed Cassandra data center. responses: '200': description: Accepted. The data center will be updated asynchronously. schema: $ref: '#/definitions/DataCenterResource' '201': description: Accepted. The data center will be created asynchronously. schema: $ref: '#/definitions/DataCenterResource' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Datacenters Datacentername tags: - Subscriptions patch: operationId: microsoftAzureCassandradatacentersUpdate description: Update some of the properties of a managed Cassandra data center. x-ms-examples: CosmosDBManagedCassandraDataCenterUpdate: $ref: ./examples/CosmosDBManagedCassandraDataCenterPatch.json x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: '#/parameters/dataCenterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: body in: body required: true schema: $ref: '#/definitions/DataCenterResource' description: Parameters to provide for specifying the managed Cassandra data center. responses: '200': description: Completed synchronously. This will only happen if the fields changed by patch require no changes to the actual Cassandra cluster, such as editing the tags. schema: $ref: '#/definitions/DataCenterResource' '202': description: Accepted. Update will proceed asynchronously. schema: $ref: '#/definitions/DataCenterResource' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Datacenters Datacentername tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/deallocate : post: operationId: microsoftAzureCassandraclustersDeallocate description: Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster. x-ms-examples: CosmosDBManagedCassandraClusterDeallocate: $ref: ./examples/CosmosDBManagedCassandraClusterDeallocate.json x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/forceDeallocate' responses: '202': description: Cluster deallocated. default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Deallocate tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/start : post: operationId: microsoftAzureCassandraclustersStart description: Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won't do anything on an already running cluster. Use Deallocate to deallocate the cluster. x-ms-examples: CosmosDBManagedCassandraClusterStart: $ref: ./examples/CosmosDBManagedCassandraClusterStart.json x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '202': description: Enqueued Operation to start the cluster. default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Start tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/status : get: operationId: microsoftAzureCassandraclustersStatus description: Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster. x-ms-examples: CosmosDBManagedCassandraStatus: $ref: ./examples/CosmosDBManagedCassandraStatus.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/clusterNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Successfully fetched the usage statistics of all nodes in the cluster. schema: $ref: '#/definitions/CassandraClusterPublicStatus' default: description: Error response describing why the operation failed. schema: $ref: cosmos-db.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Cassandraclusters Clustername Status tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/throughputPools: get: operationId: microsoftAzureThroughputpoolsList x-ms-examples: CosmosDB ThroughputPool List: $ref: ./examples/throughputPool/CosmosDBThroughputPoolList.json x-ms-pageable: nextLinkName: nextLink description: Lists all the Azure Cosmos DB Throughput Pools available under the subscription. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: The operation completed successfully. schema: $ref: '#/definitions/ThroughputPoolsListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Documentdb Throughputpools tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName} : get: operationId: microsoftAzureThroughputpoolGet x-ms-examples: CosmosDB ThroughputPool Get: $ref: ./examples/throughputPool/CosmosDBThroughputPoolGet.json description: Retrieves the properties of an existing Azure Cosmos DB Throughput Pool parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ThroughputPoolNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: The Throughput Pool properties were retrieved successfully. schema: $ref: '#/definitions/ThroughputPoolResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Throughputpools Throughputpoolname tags: - Subscriptions put: operationId: microsoftAzureThroughputpoolCreateorupdate x-ms-examples: CosmosDB ThroughputPool Create: $ref: ./examples/throughputPool/CosmosDBThroughputPoolCreate.json description: Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account. x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ThroughputPoolNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: body in: body required: true schema: $ref: '#/definitions/ThroughputPoolResource' description: The parameters to provide for the current ThroughputPool. responses: '200': description: Completed synchronously. This will only happen if the fields changed by patch require no changes to the actual ThroughputPool. schema: $ref: '#/definitions/ThroughputPoolResource' '201': description: The throughput pool is being created or updated asynchronously. Poll for status=Succeeded to find when the operation completes. schema: $ref: '#/definitions/ThroughputPoolResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Throughputpools Throughputpoolname tags: - Subscriptions patch: operationId: microsoftAzureThroughputpoolUpdate x-ms-examples: CosmosDB ThroughputPool Update: $ref: ./examples/throughputPool/CosmosDBThroughputPoolUpdate.json description: Updates the properties of an existing Azure Cosmos DB Throughput Pool. x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ThroughputPoolNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: body in: body required: false schema: $ref: '#/definitions/ThroughputPoolUpdate' description: The parameters to provide for the current Throughput Pool. responses: '200': description: Completed synchronously. This will only happen if the fields changed by patch require no changes to the actual ThroughputPool. schema: $ref: '#/definitions/ThroughputPoolResource' '202': description: The ThroughputPool update operation will complete asynchronously. headers: azure-AsyncOperation: type: string description: URI to poll for completion status. location: type: string description: URI to poll for completion status. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Throughputpools Throughputpoolname tags: - Subscriptions delete: operationId: microsoftAzureThroughputpoolDelete x-ms-examples: CosmosDB ThroughputPool Delete: $ref: ./examples/throughputPool/CosmosDBThroughputPoolDelete.json description: Deletes an existing Azure Cosmos DB Throughput Pool. x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ThroughputPoolNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '202': description: The Throughput Pool delete operation will complete asynchronously. headers: azure-AsyncOperation: type: string description: URI to poll for completion status. location: type: string description: URI to poll for completion status. '204': description: The specified Throughput Pool does not exist in the subscription. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Throughputpools Throughputpoolname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts : get: operationId: microsoftAzureThroughputpoolaccountsList x-ms-examples: CosmosDB ThroughputPool Account List: $ref: ./examples/throughputPool/CosmosDBThroughputPoolAccountsList.json x-ms-pageable: nextLinkName: nextLink description: Lists all the Azure Cosmos DB accounts available under the subscription. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ThroughputPoolNameParameter' responses: '200': description: The operation completed successfully. schema: $ref: '#/definitions/ThroughputPoolAccountsListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Throughputpools Throughputpoolname Throughputpoolaccounts tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName} : get: operationId: microsoftAzureThroughputpoolaccountGet x-ms-examples: CosmosDB ThroughputPool Account Get: $ref: ./examples/throughputPool/CosmosDBThroughputPoolAccountGet.json description: Retrieves the properties of an existing Azure Cosmos DB Throughput Pool parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ThroughputPoolNameParameter' - $ref: '#/parameters/ThroughputPoolAccountNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: The Throughput Pool properties were retrieved successfully. schema: $ref: '#/definitions/ThroughputPoolAccountResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Throughputpools Throughputpoolname Throughputpoolaccounts Throughputpoolaccountname tags: - Subscriptions put: operationId: microsoftAzureThroughputpoolaccountCreate description: Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account. x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: CosmosDB ThroughputPool Account Create: $ref: ./examples/throughputPool/CosmosDBThroughputPoolAccountCreate.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ThroughputPoolNameParameter' - $ref: '#/parameters/ThroughputPoolAccountNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: body in: body required: true schema: $ref: '#/definitions/ThroughputPoolAccountResource' description: The parameters to provide for the current ThroughputPoolAccount. responses: '200': description: The Throughput Pool account resource was retrieved successfully. schema: $ref: '#/definitions/ThroughputPoolAccountResource' '201': description: The throughput pool account is being created or updated asynchronously. Poll for status=Succeeded to find when the operation completes. schema: $ref: '#/definitions/ThroughputPoolAccountResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Throughputpools Throughputpoolname Throughputpoolaccounts Throughputpoolaccountname tags: - Subscriptions delete: operationId: microsoftAzureThroughputpoolaccountDelete x-ms-examples: CosmosDB ThroughputPool Account Delete: $ref: ./examples/throughputPool/CosmosDBThroughputPoolAccountDelete.json description: Removes an existing Azure Cosmos DB database account from a throughput pool. x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ThroughputPoolNameParameter' - $ref: '#/parameters/ThroughputPoolAccountNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '202': description: The Throughput Pool delete operation will complete asynchronously. headers: azure-AsyncOperation: type: string description: URI to poll for completion status. location: type: string description: URI to poll for completion status. '204': description: The specified Throughput Pool does not exist in the subscription. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Throughputpools Throughputpoolname Throughputpoolaccounts Throughputpoolaccountname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/availableSkus : post: tags: - Subscriptions description: This method provides the list of available skus for the given subscription, resource group and location. operationId: microsoftAzureServiceListavailableskusbyresourcegroup consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/resourceGroupNameParameter_3' - $ref: '#/parameters/locationParameter' - $ref: '#/parameters/apiVersionParameter_3' - name: availableSkuRequest in: body description: Filters for showing the available skus. required: true schema: $ref: '#/definitions/AvailableSkuRequest' responses: '200': description: The list of available skus under Resource group. schema: $ref: '#/definitions/AvailableSkusResult' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError_2' x-ms-pageable: nextLinkName: nextLink x-ms-examples: AvailableSkusPost: $ref: ./examples/AvailableSkusPost.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Locations Location Availableskus /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress: post: tags: - Subscriptions description: '[DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer shipping address and provide alternate addresses if any.' operationId: microsoftAzureServiceValidateaddress consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/locationParameter' - $ref: '#/parameters/apiVersionParameter_3' - name: validateAddress in: body description: Shipping address of the customer. required: true schema: $ref: '#/definitions/ValidateAddress' responses: '200': description: The valid and alternate addresses. schema: $ref: '#/definitions/AddressValidationOutput' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError_2' deprecated: true x-ms-examples: ValidateAddressPost: $ref: ./examples/ValidateAddressPost.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Databox Locations Location Validateaddress ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/validateInputs : post: tags: - Subscriptions description: This method does all necessary pre-job creation validation under resource group. operationId: microsoftAzureServiceValidateinputsbyresourcegroup consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/resourceGroupNameParameter_3' - $ref: '#/parameters/locationParameter' - $ref: '#/parameters/apiVersionParameter_3' - name: validationRequest in: body description: Inputs of the customer. required: true schema: $ref: '#/definitions/ValidationRequest' responses: '200': description: The validation status and responses of each validating parameter. schema: $ref: '#/definitions/ValidationResponse' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError_2' x-ms-examples: ValidateInputsByResourceGroup: $ref: ./examples/ValidateInputsByResourceGroup.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Locations Location Validateinputs /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateInputs: post: tags: - Subscriptions description: This method does all necessary pre-job creation validation under subscription. operationId: microsoftAzureServiceValidateinputs consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/locationParameter' - $ref: '#/parameters/apiVersionParameter_3' - name: validationRequest in: body description: Inputs of the customer. required: true schema: $ref: '#/definitions/ValidationRequest' responses: '200': description: The validation status and responses of each validating parameter. schema: $ref: '#/definitions/ValidationResponse' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError_2' x-ms-examples: ValidateInputs: $ref: ./examples/ValidateInputs.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Databox Locations Location Validateinputs /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration: post: tags: - Subscriptions description: This API provides configuration details specific to given region/location at Subscription level. operationId: microsoftAzureServiceRegionconfiguration consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/locationParameter' - $ref: '#/parameters/apiVersionParameter_3' - name: regionConfigurationRequest in: body description: Request body to get the configuration for the region. required: true schema: $ref: '#/definitions/RegionConfigurationRequest' responses: '200': description: Region configuration response. schema: $ref: '#/definitions/RegionConfigurationResponse' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError_2' x-ms-examples: RegionConfiguration: $ref: ./examples/RegionConfiguration.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Databox Locations Location Regionconfiguration ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration : post: tags: - Subscriptions description: This API provides configuration details specific to given region/location at Resource group level. operationId: microsoftAzureServiceRegionconfigurationbyresourcegroup consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/resourceGroupNameParameter_3' - $ref: '#/parameters/locationParameter' - $ref: '#/parameters/apiVersionParameter_3' - name: regionConfigurationRequest in: body description: Request body to get the configuration for the region at resource group level. required: true schema: $ref: '#/definitions/RegionConfigurationRequest' responses: '200': description: Region configuration response. schema: $ref: '#/definitions/RegionConfigurationResponse' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError_2' x-ms-examples: RegionConfigurationByResourceGroup: $ref: ./examples/RegionConfigurationByResourceGroup.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Locations Location Regionconfiguration /subscriptions/{subscriptionId}/providers/Microsoft.DeviceUpdate/checknameavailability: post: description: Checks ADU resource name availability. operationId: microsoftAzureChecknameavailability parameters: - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest in: body name: request required: true description: Check Name Availability Request. responses: '200': description: Check Name Availability Response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: CheckNameAvailability_Available: $ref: ./examples/CheckNameAvailability_Available.json CheckNameAvailability_AlreadyExists: $ref: ./examples/CheckNameAvailability_AlreadyExists.json deprecated: false summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Deviceupdate Checknameavailability tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.DeviceUpdate/accounts: get: description: Returns list of Accounts. operationId: microsoftAzureAccountsListbysubscription parameters: - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' responses: '200': description: List of Accounts. schema: $ref: '#/definitions/AccountList' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse deprecated: false x-ms-pageable: nextLinkName: nextLink x-ms-examples: Get list of Accounts: $ref: ./examples/Accounts/Accounts_List.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Deviceupdate Accounts tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts: get: description: Returns list of Accounts. operationId: microsoftAzureAccountsListbyresourcegroup parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' responses: '200': description: List of Accounts. schema: $ref: '#/definitions/AccountList' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse deprecated: false x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets list of Accounts: $ref: ./examples/Accounts/Accounts_List.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}: get: description: Returns account details for the given account name. operationId: microsoftAzureAccountsGet parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' responses: '200': description: Account details. schema: $ref: '#/definitions/Account' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Gets Account details: $ref: ./examples/Accounts/Accounts_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname tags: - Subscriptions head: description: Checks whether account exists. operationId: microsoftAzureAccountsHead parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' responses: '200': description: Account exists. default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Checks whether account exists: $ref: ./examples/Accounts/Accounts_Head.json summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname tags: - Subscriptions put: description: Creates or updates Account. operationId: microsoftAzureAccountsCreate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' - name: Account description: Account details. in: body required: true schema: $ref: '#/definitions/Account' responses: '201': description: Async operation to create or update Account was created. schema: $ref: '#/definitions/Account' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Creates or updates Account: $ref: ./examples/Accounts/Accounts_Create.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname tags: - Subscriptions delete: description: Deletes account. operationId: microsoftAzureAccountsDelete x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' responses: '200': description: Account was deleted. '202': description: Async operation to delete Account was created. '204': description: Account has been already deleted. default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Deletes an account: $ref: ./examples/Accounts/Accounts_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname tags: - Subscriptions patch: description: Updates account's patchable properties operationId: microsoftAzureAccountsUpdate parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' - name: accountUpdatePayload description: Updated Account. in: body required: true schema: $ref: '#/definitions/AccountUpdate' responses: '200': description: Account updated successfully. schema: $ref: '#/definitions/Account' '201': description: Async operation to update accounts was created. schema: $ref: '#/definitions/Account' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/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: Updates Account: $ref: ./examples/Accounts/Accounts_Update.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/instances : get: description: Returns instances for the given account name. operationId: microsoftAzureInstancesListbyaccount parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' responses: '200': description: List of Instances. schema: $ref: '#/definitions/InstanceList' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets list of Instances by Account: $ref: ./examples/Instances/Instances_ListByAccount.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Instances tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/instances/{instanceName} : get: description: Returns instance details for the given instance and account name. operationId: microsoftAzureInstancesGet parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' - $ref: '#/parameters/InstanceNameParameter' responses: '200': description: Instance details. schema: $ref: '#/definitions/Instance' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Gets list of Instances: $ref: ./examples/Instances/Instances_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Instances Instancename tags: - Subscriptions head: description: Checks whether instance exists. operationId: microsoftAzureInstancesHead parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' - $ref: '#/parameters/InstanceNameParameter' responses: '200': description: Instance exists. default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Checks whether instance exists.: $ref: ./examples/Instances/Instances_Head.json summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Instances Instancename tags: - Subscriptions put: description: Creates or updates instance. operationId: microsoftAzureInstancesCreate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' - $ref: '#/parameters/InstanceNameParameter' - name: Instance description: Instance details. in: body required: true schema: $ref: '#/definitions/Instance' responses: '201': description: Async operation to create or update Instance was created. schema: $ref: '#/definitions/Instance' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Creates or updates Instance: $ref: ./examples/Instances/Instances_Create.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Instances Instancename tags: - Subscriptions delete: description: Deletes instance. operationId: microsoftAzureInstancesDelete x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' - $ref: '#/parameters/InstanceNameParameter' responses: '200': description: Instance was deleted. '202': description: Async operation to delete Instance was created. '204': description: Instance has been already deleted. default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Deletes instance: $ref: ./examples/Instances/Instances_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Instances Instancename tags: - Subscriptions patch: description: Updates instance's tags. operationId: microsoftAzureInstancesUpdate parameters: - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/AccountNameParameter_2' - $ref: '#/parameters/InstanceNameParameter' - name: tagUpdatePayload description: Updated tags. in: body required: true schema: $ref: '#/definitions/TagUpdate' responses: '200': description: Instance updated successfully. schema: $ref: '#/definitions/Instance' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Updates Instance: $ref: ./examples/Instances/Instances_Update.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Instances Instancename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyId}/validate : post: description: (INTERNAL - DO NOT USE) Validates a private endpoint connection proxy object. operationId: microsoftAzurePrivateendpointconnectionproxiesValidate parameters: - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/AccountNameParameter_2' - $ref: '#/parameters/PrivateEndpointConnectionProxyIdParameter' - name: privateEndpointConnectionProxy in: body description: The parameters for creating a private endpoint connection proxy. required: true schema: $ref: '#/definitions/PrivateEndpointConnectionProxy' responses: '200': description: Validate private endpoint connection proxy empty response. default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnectionProxyValidate: $ref: ./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Validate.json deprecated: false summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privateendpointconnectionproxies Privateendpointconnectionproxyid Validate tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyId}/updatePrivateEndpointProperties : post: description: (INTERNAL - DO NOT USE) Updates a private endpoint inside the private endpoint connection proxy object. operationId: microsoftAzurePrivateendpointconnectionproxiesUpdateprivateendpointproperties parameters: - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter_8' - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/AccountNameParameter_2' - $ref: '#/parameters/PrivateEndpointConnectionProxyIdParameter' - name: privateEndpointUpdate in: body description: The parameters for updating a private endpoint connection proxy. required: true schema: $ref: '#/definitions/PrivateEndpointUpdate' responses: '200': description: Update private endpoint in private endpoint connection proxy empty response. default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnectionProxyPrivateEndpointUpdate: $ref: ./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_PrivateEndpointUpdate.json deprecated: false summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privateendpointconnectionproxies Privateendpointconnectionproxyid Updateprivateendpointproperties tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/getDnsResourceReference: post: operationId: microsoftAzureDnsresourcereferenceGetbytargetresources description: Returns the DNS records specified by the referencing targetResourceIds. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - name: parameters in: body required: true schema: $ref: '#/definitions/DnsResourceReferenceRequest' description: Properties for dns resource reference request. responses: '200': description: Success. schema: $ref: '#/definitions/DnsResourceReferenceResult' default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError_5' x-ms-examples: Get DNS resource reference: $ref: ./examples/GetDnsResourceReference.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Network Getdnsresourcereference tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensionTypes/{extensionTypeName} : get: description: Get Extension Type details operationId: microsoftAzureClusterextensiontypeGet x-ms-examples: ClusterExtensionType_Get_MaximumSet_Gen: $ref: ./examples/ClusterExtensionType_Get.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ExtensionTypeNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/ExtensionType' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Clusterrp Clusterresourcename Clustername Providers Microsoft Kubernetesconfiguration Extensiontypes Extensiontypename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensionTypes : get: description: Get Extension Types operationId: microsoftAzureClusterextensiontypesList x-ms-examples: ClusterExtensionTypes_List_MaximumSet_Gen: $ref: ./examples/ClusterExtensionTypes_List.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterRpParameter - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterResourceNameParameter - $ref: ../../common/2022-01-01-preview/parameters.json#/parameters/ClusterNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/ExtensionTypeList' 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 summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Clusterrp Clusterresourcename Clustername Providers Microsoft Kubernetesconfiguration Extensiontypes tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/Microsoft.KubernetesConfiguration/locations/{location}/extensionTypes/{extensionTypeName}/versions : get: description: List available versions for an Extension Type operationId: microsoftAzureExtensiontypeversionsList x-ms-examples: ExtensionTypeVersions_List_MaximumSet_Gen: $ref: ./examples/ExtensionTypeVersions_List.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ExtensionLocationParameter' - $ref: '#/parameters/ExtensionTypeNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/ExtensionVersionList' 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 itemName: versions summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Kubernetesconfiguration Locations Location Extensiontypes Extensiontypename Versions tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.GraphServices/accounts: get: description: Returns list of accounts apps. operationId: microsoftAzureAccountsListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: Account details. schema: $ref: '#/definitions/AccountResourceList' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Create or update account resource: $ref: ./examples/Accounts_List.json deprecated: false x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Graphservices Accounts tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.GraphServices/accounts: get: description: Returns list of accounts belonging to a subscription. operationId: microsoftAzureAccountsListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Account details. schema: $ref: '#/definitions/AccountResourceList' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Get list of accounts by subscription: $ref: ./examples/Accounts_List_Sub.json deprecated: false x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Graphservices Accounts tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.GraphServices/accounts/{resourceName} : get: description: Returns account resource for a given name. operationId: microsoftAzureAccountGet parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceNameParameter_3' responses: '200': description: Account details. schema: $ref: '#/definitions/AccountResource' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Get accounts: $ref: ./examples/Accounts_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Graphservices Accounts Resourcename tags: - Subscriptions put: description: Create or update account resource. operationId: microsoftAzureAccountCreateandupdate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceNameParameter_3' - name: accountResource description: Account details. in: body required: true schema: $ref: '#/definitions/AccountResource' responses: '200': description: Successful. schema: $ref: '#/definitions/AccountResource' '201': description: Created. schema: $ref: '#/definitions/AccountResource' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Create Account resource: $ref: ./examples/Accounts_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Graphservices Accounts Resourcename tags: - Subscriptions patch: description: Update account details. operationId: microsoftAzureAccountUpdate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceNameParameter_3' - name: accountResource description: Account patch details. in: body required: true schema: $ref: '#/definitions/AccountPatchResource' responses: '200': description: Successful. schema: $ref: '#/definitions/AccountResource' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Update account resource: $ref: ./examples/Accounts_Update.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Graphservices Accounts Resourcename tags: - Subscriptions delete: description: Deletes a account resource. operationId: microsoftAzureAccountDelete parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceNameParameter_3' responses: '200': description: Account was deleted. '204': description: Account has been already deleted. default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Delete account resource: $ref: ./examples/Accounts_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Graphservices Accounts Resourcename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/guestDiagnosticSettings/{diagnosticSettingsName} : patch: description: Updates guest diagnostics settings. operationId: microsoftAzureGuestdiagnosticssettingsUpdate parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DiagnosticSettingNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - name: parameters in: body required: true schema: $ref: '#/definitions/GuestDiagnosticSettingsPatchResource' description: The configuration to patch. responses: '200': description: An existing guest diagnostic settings was successfully updated. schema: $ref: '#/definitions/GuestDiagnosticSettingsResource' '201': description: A new guest diagnostic settings was successfully created. schema: $ref: '#/definitions/GuestDiagnosticSettingsResource' default: description: An error occurred and the guest diagnostic settings could not be created or updated. schema: $ref: '#/definitions/ErrorResponse_6' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Guestdiagnosticsettings Diagnosticsettingsname tags: - Subscriptions /subscriptions/{subscriptionId}/providers/microsoft.insights/guestDiagnosticSettings: get: description: Get a list of all guest diagnostic settings in a subscription. operationId: microsoftAzureGuestdiagnosticssettingsList x-ms-pageable: nextLinkName: null parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/GuestDiagnosticSettingsList' default: description: An error occurred and the list of guest diagnostic settings could not be retrieved. schema: $ref: '#/definitions/ErrorResponse_6' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Insights Guestdiagnosticsettings tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/guestDiagnosticSettings: get: description: Get a list of all guest diagnostic settings in a resource group. operationId: microsoftAzureGuestdiagnosticssettingsListbyresourcegroup x-ms-pageable: nextLinkName: null parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/GuestDiagnosticSettingsList' default: description: An error occurred and the list of guest diagnostic settings could not be retrieved. schema: $ref: '#/definitions/ErrorResponse_6' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Guestdiagnosticsettings tags: - Subscriptions /subscriptions/{subscriptionId}/providers/microsoft.insights/guestDiagnosticSettingsAssociations: get: description: Get a list of all guest diagnostic settings association in a subscription. operationId: microsoftAzureGuestdiagnosticssettingsassociationList x-ms-pageable: nextLinkName: null parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/GuestDiagnosticSettingsAssociationList' default: description: An error occurred and the list of guest diagnostic settings association could not be retrieved. schema: $ref: '#/definitions/ErrorResponse_7' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Insights Guestdiagnosticsettingsassociations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/guestDiagnosticSettingsAssociations : get: description: Get a list of all guest diagnostic settings association in a resource group. operationId: microsoftAzureGuestdiagnosticssettingsassociationListbyresourcegroup x-ms-pageable: nextLinkName: null parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/GuestDiagnosticSettingsAssociationList' default: description: An error occurred and the list of guest diagnostic settings association could not be retrieved. schema: $ref: '#/definitions/ErrorResponse_7' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Guestdiagnosticsettingsassociations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName} : get: description: Gets a cluster pool. operationId: microsoftAzureClusterpoolsGet x-ms-examples: ClusterPoolGet: $ref: ./examples/GetClusterPool.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' responses: '200': description: Clusterpool details. schema: $ref: '#/definitions/ClusterPool' default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname tags: - Subscriptions put: description: Creates or updates a cluster pool. operationId: microsoftAzureClusterpoolsCreateorupdate x-ms-examples: ClusterPoolPut: $ref: ./examples/CreateClusterPool.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' - name: ClusterPool description: The Cluster Pool to create. in: body required: true schema: $ref: '#/definitions/ClusterPool' responses: '200': description: Update successful. schema: $ref: '#/definitions/ClusterPool' '201': description: ClusterPool is created. schema: $ref: '#/definitions/ClusterPool' default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname tags: - Subscriptions patch: description: Updates an existing Cluster Pool Tags. operationId: microsoftAzureClusterpoolsUpdatetags x-ms-examples: ClusterPoolsPatchTags: $ref: ./examples/PatchClusterPool.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ClusterPoolNameParameter' - name: clusterPoolTags in: body required: true schema: $ref: '#/definitions/TagsObject_2' description: Parameters supplied to update tags. responses: '200': description: Successful. schema: $ref: '#/definitions/ClusterPool' '202': description: Accepted. headers: Location: type: string schema: $ref: '#/definitions/ClusterPool' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname tags: - Subscriptions delete: description: Deletes a Cluster Pool. operationId: microsoftAzureClusterpoolsDelete x-ms-examples: ClusterPoolDelete: $ref: ./examples/DeleteClusterPool.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' responses: '200': description: Successful. '202': description: Accepted response definition. headers: Location: type: string '204': description: No content - The Cluster Pool doesn't exist. default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusterpools: get: operationId: microsoftAzureClusterpoolsListbysubscription x-ms-examples: ClusterPoolsListBySubscription: $ref: ./examples/ListClusterPoolsSubscription.json description: Gets the list of Cluster Pools within a Subscription. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Cluster Pools successfully returned. schema: $ref: '#/definitions/ClusterPoolListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Hdinsight Clusterpools tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools: get: operationId: microsoftAzureClusterpoolsListbyresourcegroup x-ms-examples: ClusterPoolsListByResourceGroup: $ref: ./examples/ListClusterPools.json description: Lists the HDInsight cluster pools under a resource group. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Cluster Pools successfully returned. schema: $ref: '#/definitions/ClusterPoolListResult' default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters : get: operationId: microsoftAzureClustersListbyclusterpoolname description: Lists the HDInsight cluster pools under a resource group. x-ms-examples: HDInsightClustersListByClusterPoolName: $ref: ./examples/ListClustersByClusterPoolName.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' responses: '200': description: Clusters successfully returned. schema: $ref: '#/definitions/ClusterListResult' default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/resize : post: description: Resize an existing Cluster. operationId: microsoftAzureClustersResize x-ms-examples: HDInsightClusterResize: $ref: ./examples/ResizeCluster.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ClusterPoolNameParameter' - $ref: '#/parameters/ClusterNameParameter_2' - name: ClusterResizeRequest in: body required: true schema: $ref: '#/definitions/ClusterResizeData' description: Resize a cluster. responses: '200': description: Successful. schema: $ref: '#/definitions/Cluster' '202': description: Cluster resize request accepted. headers: location: type: string description: URL to get the status of the resize operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters Clustername Resize tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName} : get: operationId: microsoftAzureClustersGet description: Gets a HDInsight cluster. x-ms-examples: HDInsightClusterGet: $ref: ./examples/GetCluster.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' - $ref: '#/parameters/ClusterNameParameter_2' responses: '200': description: Cluster details. schema: $ref: '#/definitions/Cluster' default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters Clustername tags: - Subscriptions put: operationId: microsoftAzureClustersCreate description: Creates a cluster. x-ms-examples: HDInsightClusterPut: $ref: ./examples/CreateAutoscaleCluster.json HDInsightSparkClusterPut: $ref: ./examples/CreateSparkCluster.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' - $ref: '#/parameters/ClusterNameParameter_2' - name: HDInsightCluster in: body required: true description: The cluster to create. schema: $ref: '#/definitions/Cluster' responses: '200': description: Update successful. schema: $ref: '#/definitions/Cluster' '201': description: Cluster is created. schema: $ref: '#/definitions/Cluster' default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters Clustername tags: - Subscriptions patch: description: Updates an existing Cluster. operationId: microsoftAzureClustersUpdate x-ms-examples: HDInsightClustersPatchTags: $ref: ./examples/PatchCluster.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/ClusterPoolNameParameter' - $ref: '#/parameters/ClusterNameParameter_2' - name: ClusterPatchRequest in: body required: true schema: $ref: '#/definitions/ClusterPatch' description: Patch a cluster. responses: '200': description: Successful. schema: $ref: '#/definitions/Cluster' '202': description: Accepted. headers: Location: type: string schema: $ref: '#/definitions/Cluster' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters Clustername tags: - Subscriptions delete: operationId: microsoftAzureClustersDelete description: Deletes a cluster. x-ms-examples: HDInsightClustersDelete: $ref: ./examples/DeleteCluster.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' - $ref: '#/parameters/ClusterNameParameter_2' responses: '200': description: Successful. '202': description: Cluster delete request accepted. headers: Location: type: string '204': description: No content - The Cluster doesn't exist. default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters Clustername tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/runJob : post: operationId: microsoftAzureClusterjobsRunjob description: Operations on jobs of HDInsight on AKS cluster. x-ms-examples: RunClusterJob: $ref: ./examples/RunClusterJob.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' - $ref: '#/parameters/ClusterNameParameter_2' - name: ClusterJob description: The Cluster job. in: body required: true schema: $ref: '#/definitions/ClusterJob' responses: '200': description: Successful. schema: $ref: '#/definitions/ClusterJob' '202': description: Run cluster job action request accepted. headers: location: type: string description: URL to get the status of the resize operation. default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters Clustername Runjob tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/jobs : get: operationId: microsoftAzureClusterjobsList description: Get jobs of HDInsight on AKS cluster. x-ms-examples: ListClusterJobs: $ref: ./examples/ListClusterJobs.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' - $ref: '#/parameters/ClusterNameParameter_2' responses: '200': description: Cluster job details. schema: $ref: '#/definitions/ClusterJobList' default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters Clustername Jobs tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/serviceConfigs : get: operationId: microsoftAzureClustersListserviceconfigs description: Lists the config dump of all services running in cluster. x-ms-examples: HDInsightClusterGetServiceConfigs: $ref: ./examples/ListClusterServiceConfigs.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' - $ref: '#/parameters/ClusterNameParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/ServiceConfigListResult' default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters Clustername Serviceconfigs tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/checkNameAvailability: post: description: Check the availability of the resource name. operationId: microsoftAzureLocationsChecknameavailability x-ms-examples: LocationsNameAvailability: $ref: ./examples/LocationsNameAvailability.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter - name: NameAvailabilityParameters in: body required: true schema: $ref: '#/definitions/NameAvailabilityParameters' description: The name and type of the resource. responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/NameAvailabilityResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Hdinsight Locations Location Checknameavailability tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews : get: operationId: microsoftAzureClustersListinstanceviews x-ms-examples: HDInsightClusterGetInstanceViews: $ref: ./examples/ListClusterInstanceViews.json description: Lists the lists of instance views parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' - $ref: '#/parameters/ClusterNameParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/ClusterInstanceViewsResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters Clustername Instanceviews tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews/default : get: operationId: microsoftAzureClustersGetinstanceview description: Gets the status of a cluster instance. x-ms-examples: HDInsightClusterGetInstanceView: $ref: ./examples/GetClusterInstanceView.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ClusterPoolNameParameter' - $ref: '#/parameters/ClusterNameParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/ClusterInstanceViewResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusterpools Clusterpoolname Clusters Clustername Instanceviews Default tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterPoolVersions: get: description: Returns a list of available cluster pool versions. operationId: microsoftAzureAvailableclusterpoolversionsListbylocation x-ms-examples: ClusterPoolVersionListResult: $ref: ./examples/ListAvailableClusterPoolVersions.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Available cluster pool versions successfully returned. schema: $ref: '#/definitions/ClusterPoolVersionsListResult' default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Hdinsight Locations Location Availableclusterpoolversions tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterVersions: get: description: Returns a list of available cluster versions. operationId: microsoftAzureAvailableclusterversionsListbylocation x-ms-examples: ClusterVersionListResult: $ref: ./examples/ListAvailableClusterVersions.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Available cluster versions successfully returned. schema: $ref: '#/definitions/ClusterVersionsListResult' default: description: Error Response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Hdinsight Locations Location Availableclusterversions tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.HealthBot/checkNameAvailability: post: description: Check whether a bot name is available. operationId: microsoftAzureBotsChecknameavailability x-ms-examples: check Name Availability: $ref: ./examples/CheckNameAvailability.json parameters: - name: parameters in: body required: true schema: $ref: '#/definitions/CheckNameAvailabilityRequestBody' description: The request body parameters to provide for the check name availability request - $ref: '#/parameters/subscriptionIdParameter_4' - $ref: '#/parameters/apiVersionParameter_4' responses: '200': description: The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code. schema: $ref: '#/definitions/CheckNameAvailabilityResponseBody' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Healthbot Checknameavailability tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes: get: description: Gets a list of all Azure Arc PrivateLinkScopes within a subscription. operationId: microsoftAzurePrivatelinkscopesList parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: A list containing 0 or more Azure Arc PrivateLinkScope definitions. schema: $ref: '#/definitions/HybridComputePrivateLinkScopeListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopesList.json: $ref: ./examples/privateLinkScope/PrivateLinkScopes_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Hybridcompute Privatelinkscopes tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes: get: description: Gets a list of Azure Arc PrivateLinkScopes within a resource group. operationId: microsoftAzurePrivatelinkscopesListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: A list containing 0 or more Azure Arc PrivateLinkScope definitions. schema: $ref: '#/definitions/HybridComputePrivateLinkScopeListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopeListByResourceGroup: $ref: ./examples/privateLinkScope/PrivateLinkScopes_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName} : delete: description: Deletes a Azure Arc PrivateLinkScope. operationId: microsoftAzurePrivatelinkscopesDelete parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName' responses: '200': description: Successful request when deleting an Azure Arc PrivateLinkScope. '202': description: Accepted. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. type: integer format: int32 Azure-AsyncOperation: description: The URI to poll for completion status. type: string '204': description: The specified PrivateLinkScope does not exist. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: PrivateLinkScopesDelete: $ref: ./examples/privateLinkScope/PrivateLinkScopes_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes Scopename tags: - Subscriptions get: description: Returns a Azure Arc PrivateLinkScope. operationId: microsoftAzurePrivatelinkscopesGet parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName' responses: '200': description: Azure Arc PrivateLinkScope definition. schema: $ref: '#/definitions/HybridComputePrivateLinkScope' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopeGet: $ref: ./examples/privateLinkScope/PrivateLinkScopes_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes Scopename tags: - Subscriptions put: description: 'Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.' operationId: microsoftAzurePrivatelinkscopesCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName' - name: parameters description: Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope. in: body required: true schema: $ref: '#/definitions/HybridComputePrivateLinkScope' responses: '200': description: Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope is returned. schema: $ref: '#/definitions/HybridComputePrivateLinkScope' '201': description: Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope was created and is returned. schema: $ref: '#/definitions/HybridComputePrivateLinkScope' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopeCreate: $ref: ./examples/privateLinkScope/PrivateLinkScopes_Create.json PrivateLinkScopeUpdate: $ref: ./examples/privateLinkScope/PrivateLinkScopes_Update.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes Scopename tags: - Subscriptions patch: description: Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method. operationId: microsoftAzurePrivatelinkscopesUpdatetags parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName' - name: PrivateLinkScopeTags description: Updated tag information to set into the PrivateLinkScope instance. in: body required: true schema: $ref: '#/definitions/TagsResource_3' responses: '200': description: Updating the Azure Arc PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties. schema: $ref: '#/definitions/HybridComputePrivateLinkScope' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopeUpdateTagsOnly: $ref: ./examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes Scopename tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId} : get: description: Returns a Azure Arc PrivateLinkScope's validation details. operationId: microsoftAzurePrivatelinkscopesGetvalidationdetails parameters: - $ref: '#/parameters/LocationParameter_3' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeId' responses: '200': description: Azure Arc PrivateLinkScope validation details definition. schema: $ref: '#/definitions/PrivateLinkScopeValidationDetails' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopeGet: $ref: ./examples/privateLinkScope/PrivateLinkScopes_GetValidation.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Hybridcompute Locations Location Privatelinkscopes Privatelinkscopeid tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current : get: description: Returns a Azure Arc PrivateLinkScope's validation details for a given machine. operationId: microsoftAzurePrivatelinkscopesGetvalidationdetailsformachine parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/MachineNameParameter' responses: '200': description: Azure Arc PrivateLinkScope validation details definition. schema: $ref: '#/definitions/PrivateLinkScopeValidationDetails' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopeGet: $ref: ./examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Machines Machinename Privatelinkscopes Current tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworksName} : get: operationId: microsoftAzureVirtualnetworksRetrieve x-ms-examples: GetVirtualNetwork: $ref: ./examples/GetVirtualNetwork.json summary: Microsoft Azure Gets The Virtual Network description: Gets the Hybrid AKS virtual network parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/virtualNetworksNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: Retrieves the virtualNetworks resource. schema: $ref: '#/definitions/virtualNetworks' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse tags: - Subscriptions put: operationId: microsoftAzureVirtualnetworksCreateorupdate x-ms-examples: PutVirtualNetwork: $ref: ./examples/PutVirtualNetwork.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Puts The Virtual Network description: Puts the Hybrid AKS virtual network parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/virtualNetworksNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: virtualNetworks in: body required: true schema: $ref: '#/definitions/virtualNetworks' responses: '200': description: Updates the virtualNetworks resource. schema: $ref: '#/definitions/virtualNetworks' '201': description: Creates the virtualNetworks resource. schema: $ref: '#/definitions/virtualNetworks' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse tags: - Subscriptions delete: operationId: microsoftAzureVirtualnetworksDelete x-ms-examples: DeleteVirtualNetwork: $ref: ./examples/DeleteVirtualNetwork.json summary: Microsoft Azure Deletes The Virtual Network description: Deletes the Hybrid AKS virtual network parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/virtualNetworksNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: Deletes the virtualNetworks resource. '204': description: No content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse tags: - Subscriptions patch: operationId: microsoftAzureVirtualnetworksUpdate x-ms-examples: UpdateVirtualNetwork: $ref: ./examples/UpdateVirtualNetwork.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Patches The Virtual Network description: Patches the Hybrid AKS virtual network parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/virtualNetworksNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: virtualNetworks in: body required: true schema: $ref: '#/definitions/virtualNetworksPatch' responses: '200': description: Updates the virtualNetworks resource. schema: $ref: '#/definitions/virtualNetworks' '202': description: Updates the virtualNetworks resource. schema: $ref: '#/definitions/virtualNetworks' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks : get: operationId: microsoftAzureVirtualnetworksListbyresourcegroup x-ms-examples: ListVirtualNetworkByResourceGroup: $ref: ./examples/ListVirtualNetworkByResourceGroup.json summary: Microsoft Azure List Virtual Networks By Resource Group description: Lists the Hybrid AKS virtual networks by resource group parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: Lists all virtualNetworks under the resource group. schema: $ref: '#/definitions/virtualNetworksListResult' 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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.HybridContainerService/virtualNetworks: get: operationId: microsoftAzureVirtualnetworksListbysubscription x-ms-examples: ListVirtualNetworkBySubscription: $ref: ./examples/ListVirtualNetworkBySubscription.json summary: Microsoft Azure List Virtual Networks By Subscription description: Lists the Hybrid AKS virtual networks by subscription parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: Lists all virtualNetworks under the subscription. schema: $ref: '#/definitions/virtualNetworksListResult' 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 tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/skus: get: description: Lists eligible SKUs for Kusto resource provider. x-ms-examples: KustoClustersListSkus: $ref: ./examples/KustoClustersListSkus.json operationId: microsoftAzureClustersListskus parameters: - $ref: '#/parameters/ApiVersionParameter_9' - $ref: '#/parameters/SubscriptionIdParameter_9' responses: '200': description: OK. schema: $ref: '#/definitions/ListSkusResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_6' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Kusto Skus tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.ManagedIdentity/userAssignedIdentities: get: operationId: microsoftAzureUserassignedidentitiesListbysubscription description: Lists all the userAssignedIdentities available under the specified subscription. x-ms-examples: IdentityListBySubscription: $ref: ./examples/IdentityListBySubscription.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_10' - $ref: '#/parameters/ApiVersionParameter_10' 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_7' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Managedidentity Userassignedidentities tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities : get: operationId: microsoftAzureUserassignedidentitiesListbyresourcegroup description: Lists all the userAssignedIdentities available under the specified ResourceGroup. x-ms-examples: IdentityListByResourceGroup: $ref: ./examples/IdentityListByResourceGroup.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_10' - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ApiVersionParameter_10' 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_7' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Managedidentity Userassignedidentities tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/listAssociatedResources : post: operationId: microsoftAzureUserassignedidentitiesListassociatedresources description: Lists the associated resources for this identity. x-ms-examples: IdentityListAssociatedResources: $ref: ./examples/IdentityListAssociatedResources.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_10' - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ResourceNameParameter_4' - $ref: '#/parameters/FilterParameter' - $ref: '#/parameters/OrderbyParameter' - $ref: '#/parameters/TopQueryParameter' - $ref: '#/parameters/SkipQueryParameter' - $ref: '#/parameters/SkipTokenParameter' - $ref: '#/parameters/ApiVersionParameter_10' responses: '200': description: OK. List of resources associated with this identity. schema: $ref: '#/definitions/AssociatedResourcesListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_7' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Managedidentity Userassignedidentities Resourcename Listassociatedresources tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName} : put: operationId: microsoftAzureUserassignedidentitiesCreateorupdate 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_10' - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ResourceNameParameter_4' - $ref: '#/parameters/ApiVersionParameter_10' - name: parameters in: body required: true schema: $ref: '#/definitions/Identity_2' description: Parameters to create or update the identity responses: '200': description: Updated identity schema: $ref: '#/definitions/Identity_2' '201': description: Created identity schema: $ref: '#/definitions/Identity_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_7' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Managedidentity Userassignedidentities Resourcename tags: - Subscriptions patch: operationId: microsoftAzureUserassignedidentitiesUpdate description: Update an identity in the specified subscription and resource group. x-ms-examples: IdentityUpdate: $ref: ./examples/IdentityUpdate.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_10' - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ResourceNameParameter_4' - $ref: '#/parameters/ApiVersionParameter_10' - 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_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_7' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Managedidentity Userassignedidentities Resourcename tags: - Subscriptions get: operationId: microsoftAzureUserassignedidentitiesGet description: Gets the identity. x-ms-examples: IdentityGet: $ref: ./examples/IdentityGet.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_10' - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ResourceNameParameter_4' - $ref: '#/parameters/ApiVersionParameter_10' responses: '200': description: OK. The requested identity. schema: $ref: '#/definitions/Identity_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_7' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Managedidentity Userassignedidentities Resourcename tags: - Subscriptions delete: operationId: microsoftAzureUserassignedidentitiesDelete description: Deletes the identity. x-ms-examples: IdentityDelete: $ref: ./examples/IdentityDelete.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_10' - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ResourceNameParameter_4' - $ref: '#/parameters/ApiVersionParameter_10' 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_7' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Managedidentity Userassignedidentities Resourcename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials : get: operationId: microsoftAzureFederatedidentitycredentialsList 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_10' - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ResourceNameParameter_4' - $ref: '#/parameters/TopQueryParameter' - $ref: '#/parameters/SkipTokenParameter' - $ref: '#/parameters/ApiVersionParameter_10' 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_7' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Managedidentity Userassignedidentities Resourcename Federatedidentitycredentials tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials/{federatedIdentityCredentialResourceName} : put: operationId: microsoftAzureFederatedidentitycredentialsCreateorupdate 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_10' - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ResourceNameParameter_4' - $ref: '#/parameters/FederatedIdentityCredentialResourceNameParameter' - $ref: '#/parameters/ApiVersionParameter_10' - 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_7' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Managedidentity Userassignedidentities Resourcename Federatedidentitycredentials Federatedidentitycredentialresourcename tags: - Subscriptions get: operationId: microsoftAzureFederatedidentitycredentialsGet description: Gets the federated identity credential. x-ms-examples: FederatedIdentityCredentialGet: $ref: ./examples/FederatedIdentityCredentialGet.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_10' - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ResourceNameParameter_4' - $ref: '#/parameters/FederatedIdentityCredentialResourceNameParameter' - $ref: '#/parameters/ApiVersionParameter_10' 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_7' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Managedidentity Userassignedidentities Resourcename Federatedidentitycredentials Federatedidentitycredentialresourcename tags: - Subscriptions delete: operationId: microsoftAzureFederatedidentitycredentialsDelete description: Deletes the federated identity credential. x-ms-examples: FederatedIdentityCredentialDelete: $ref: ./examples/FederatedIdentityCredentialDelete.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_10' - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ResourceNameParameter_4' - $ref: '#/parameters/FederatedIdentityCredentialResourceNameParameter' - $ref: '#/parameters/ApiVersionParameter_10' 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_7' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Managedidentity Userassignedidentities Resourcename Federatedidentitycredentials Federatedidentitycredentialresourcename tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/offerTypes/{offerType}/publishers/{publisherId}/offers/{offerId}/plans/{planId}/agreements/current : get: operationId: microsoftAzureMarketplaceagreementsGet x-ms-examples: GetMarketplaceTerms: $ref: ./examples/GetMarketplaceTerms.json description: Get marketplace terms. parameters: - $ref: '#/parameters/ApiVersionParameter_11' - $ref: '#/parameters/SubscriptionIdParameter_11' - $ref: '#/parameters/OfferTypeParameter' - $ref: '#/parameters/PublishersParameter' - $ref: '#/parameters/OffersParameter' - $ref: '#/parameters/PlansParameter' responses: '200': description: Terms returned successfully schema: $ref: '#/definitions/AgreementTerms' default: description: Microsoft.MarketplaceOrdering error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_8' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Marketplaceordering Offertypes Offertype Publishers Publisherid Offers Offerid Plans Planid Agreements Current tags: - Subscriptions put: operationId: microsoftAzureMarketplaceagreementsCreate description: Save marketplace terms. x-ms-examples: SetMarketplaceTerms: $ref: ./examples/SetMarketplaceTerms.json parameters: - $ref: '#/parameters/ApiVersionParameter_11' - $ref: '#/parameters/OfferTypeParameter' - $ref: '#/parameters/SubscriptionIdParameter_11' - $ref: '#/parameters/PublishersParameter' - $ref: '#/parameters/OffersParameter' - $ref: '#/parameters/PlansParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/AgreementTerms' description: Parameters supplied to the Create Marketplace Terms operation. responses: '200': description: OK. The request was successfully processed and the terms were accepted or acceptance revoked as per the request body. schema: $ref: '#/definitions/AgreementTerms' default: description: Microsoft.MarketplaceOrdering error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_8' summary: Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Marketplaceordering Offertypes Offertype Publishers Publisherid Offers Offerid Plans Planid Agreements Current tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}/sign : post: operationId: microsoftAzureMarketplaceagreementsSign description: Sign marketplace terms. x-ms-examples: SetMarketplaceTerms: $ref: ./examples/SignMarketplaceTerms.json parameters: - $ref: '#/parameters/ApiVersionParameter_11' - $ref: '#/parameters/SubscriptionIdParameter_11' - $ref: '#/parameters/PublishersParameter' - $ref: '#/parameters/OffersParameter' - $ref: '#/parameters/PlansParameter' responses: '200': description: OK. The request was successfully processed and the terms were accepted. schema: $ref: '#/definitions/OldAgreementTerms' default: description: Microsoft.MarketplaceOrdering error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_8' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Marketplaceordering Agreements Publisherid Offers Offerid Plans Planid Sign tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}/cancel : post: operationId: microsoftAzureMarketplaceagreementsCancel description: Cancel marketplace terms. x-ms-examples: SetMarketplaceTerms: $ref: ./examples/CancelMarketplaceTerms.json parameters: - $ref: '#/parameters/ApiVersionParameter_11' - $ref: '#/parameters/SubscriptionIdParameter_11' - $ref: '#/parameters/PublishersParameter' - $ref: '#/parameters/OffersParameter' - $ref: '#/parameters/PlansParameter' responses: '200': description: OK. The request was successfully processed and the terms were rejected. schema: $ref: '#/definitions/OldAgreementTerms' default: description: Microsoft.MarketplaceOrdering error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_8' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Marketplaceordering Agreements Publisherid Offers Offerid Plans Planid Cancel tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId} : get: operationId: microsoftAzureMarketplaceagreementsGetagreement description: Get marketplace agreement. x-ms-examples: SetMarketplaceTerms: $ref: ./examples/GetAgreementMarketplaceTerms.json parameters: - $ref: '#/parameters/ApiVersionParameter_11' - $ref: '#/parameters/SubscriptionIdParameter_11' - $ref: '#/parameters/PublishersParameter' - $ref: '#/parameters/OffersParameter' - $ref: '#/parameters/PlansParameter' responses: '200': description: Terms returned successfully schema: $ref: '#/definitions/OldAgreementTerms' default: description: Microsoft.MarketplaceOrdering error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_8' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Marketplaceordering Agreements Publisherid Offers Offerid Plans Planid tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements: get: operationId: microsoftAzureMarketplaceagreementsList description: List marketplace agreements in the subscription. x-ms-examples: ListMarketplaceTerms: $ref: ./examples/ListMarketplaceTerms.json parameters: - $ref: '#/parameters/ApiVersionParameter_11' - $ref: '#/parameters/SubscriptionIdParameter_11' responses: '200': description: Terms returned successfully schema: $ref: '#/definitions/OldAgreementTermsList' default: description: Microsoft.MarketplaceOrdering error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_8' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Marketplaceordering Agreements tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Media/CheckNameAvailability: post: operationId: microsoftAzureMediaserviceChecknameavailability description: Checks whether the Media Service resource name is available. The name must be globally unique. externalDocs: url: https://aka.ms/media-manage x-ms-examples: MediaServiceCheckNameAvailability: $ref: ./examples/MediaServiceCheckNameAvailability.json parameters: - $ref: '#/parameters/subscriptionIdParameter_5' - $ref: '#/parameters/apiVersionParameter_5' - name: parameters description: Properties needed to check the availability of a name. in: body required: true schema: $ref: '#/definitions/CheckNameAvailabilityInput' responses: '200': description: Success. Returns details about whether a Media Service resource name is available. schema: $ref: '#/definitions/CheckNameAvailabilityOutput' examples: application/json: nameAvailable: false reason: AlreadyExists message: Already in use by another Media Service instance. Please try again with a name that is not likely to be in use. default: description: CheckNameAvailability of a Media Service failed. schema: $ref: '#/definitions/ApiError_3' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Media Checknameavailability tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices: get: operationId: microsoftAzureMediaserviceListbyresourcegroup description: Lists all of the Media Services in a resource group. externalDocs: url: https://aka.ms/media-manage x-ms-examples: MediaServiceListByResourceGroup: $ref: ./examples/MediaServiceListByResourceGroup.json parameters: - $ref: '#/parameters/subscriptionIdParameter_5' - $ref: '#/parameters/apiVersionParameter_5' - $ref: '#/parameters/resourceGroupNameParameter_5' responses: '200': description: Success. Returns a list of all of the Media Services accounts in a resource group. schema: $ref: '#/definitions/MediaServiceCollection' examples: application/json: value: - name: contosomedia id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia type: Microsoft.Media/mediaservices location: West US properties: apiEndpoints: - endpoint: https://wamsbayclus001rest-hs.cloudapp.net/api/ majorVersion: '2' storageAccounts: - id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia isPrimary: true default: description: List Media Services failed. schema: $ref: '#/definitions/ApiError_3' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName} : get: operationId: microsoftAzureMediaserviceGet description: Gets a Media Service. externalDocs: url: https://aka.ms/media-manage x-ms-examples: MediaServiceGet: $ref: ./examples/MediaServiceGet.json parameters: - $ref: '#/parameters/subscriptionIdParameter_5' - $ref: '#/parameters/apiVersionParameter_5' - $ref: '#/parameters/resourceGroupNameParameter_5' - $ref: '#/parameters/mediaResourceNameParameter' responses: '200': description: Success. Returns the details of the Media Services account. schema: $ref: '#/definitions/MediaService' examples: application/json: name: contosomedia id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia type: Microsoft.Media/mediaservices location: West US properties: apiEndpoints: - endpoint: https://wamsbayclus001rest-hs.cloudapp.net/api/ majorVersion: '2' storageAccounts: - id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia isPrimary: true default: description: Get Media Services failed. schema: $ref: '#/definitions/ApiError_3' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename tags: - Subscriptions put: operationId: microsoftAzureMediaserviceCreate description: Creates a Media Service. externalDocs: url: https://aka.ms/media-manage x-ms-examples: MediaServiceCreate: $ref: ./examples/MediaServiceCreate.json parameters: - $ref: '#/parameters/subscriptionIdParameter_5' - $ref: '#/parameters/apiVersionParameter_5' - $ref: '#/parameters/resourceGroupNameParameter_5' - $ref: '#/parameters/mediaResourceNameParameter' - name: parameters description: Media Service properties needed for creation. in: body required: true schema: $ref: '#/definitions/MediaService' responses: '201': description: Success. Returns the new Media Services account. schema: $ref: '#/definitions/MediaService' examples: application/json: name: contosomedia id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia type: Microsoft.Media/mediaservices location: West US properties: apiEndpoints: - endpoint: https://wamsbayclus001rest-hs.cloudapp.net/api/ majorVersion: '2' storageAccounts: - id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia isPrimary: true default: description: Create Media Services failed. schema: $ref: '#/definitions/ApiError_3' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename tags: - Subscriptions delete: operationId: microsoftAzureMediaserviceDelete description: Deletes a Media Service. externalDocs: url: https://aka.ms/media-manage x-ms-examples: MediaServiceDelete: $ref: ./examples/MediaServiceDelete.json parameters: - $ref: '#/parameters/subscriptionIdParameter_5' - $ref: '#/parameters/apiVersionParameter_5' - $ref: '#/parameters/resourceGroupNameParameter_5' - $ref: '#/parameters/mediaResourceNameParameter' responses: '200': description: Success. The Media Services account was deleted. '204': description: No Content. The account name does not exist. default: description: Delete Media Services failed. schema: $ref: '#/definitions/ApiError_3' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename tags: - Subscriptions patch: operationId: microsoftAzureMediaserviceUpdate description: Updates a Media Service. externalDocs: url: https://aka.ms/media-manage x-ms-examples: MediaServiceUpdate: $ref: ./examples/MediaServiceUpdate.json parameters: - $ref: '#/parameters/subscriptionIdParameter_5' - $ref: '#/parameters/apiVersionParameter_5' - $ref: '#/parameters/resourceGroupNameParameter_5' - $ref: '#/parameters/mediaResourceNameParameter' - name: parameters description: Media Service properties needed for update. in: body required: true schema: $ref: '#/definitions/MediaService' responses: '200': description: Success. The Media Services account was updated. schema: $ref: '#/definitions/MediaService' examples: application/json: name: contosomedia id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia type: Microsoft.Media/mediaservices location: West US properties: apiEndpoints: - endpoint: https://wamsbayclus001rest-hs.cloudapp.net/api/ majorVersion: '2' storageAccounts: - id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia isPrimary: true default: description: Update Media Services failed. schema: $ref: '#/definitions/ApiError_3' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/regenerateKey : post: operationId: microsoftAzureMediaserviceRegeneratekey description: Regenerates a primary or secondary key for a Media Service. externalDocs: url: https://aka.ms/media-manage x-ms-examples: MediaServiceRegenerateKey: $ref: ./examples/MediaServiceRegenerateKey.json parameters: - $ref: '#/parameters/subscriptionIdParameter_5' - $ref: '#/parameters/apiVersionParameter_5' - $ref: '#/parameters/resourceGroupNameParameter_5' - $ref: '#/parameters/mediaResourceNameParameter' - name: parameters description: Properties needed to regenerate the Media Service key. in: body required: true schema: $ref: '#/definitions/RegenerateKeyInput' responses: '200': description: Success. The Media Services key specified in the input was regenerated. schema: $ref: '#/definitions/RegenerateKeyOutput' examples: application/json: key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= default: description: Regenerate Media Service key failed. schema: $ref: '#/definitions/ApiError_3' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename Regeneratekey tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/listKeys : post: operationId: microsoftAzureMediaserviceListkeys description: Lists the keys for a Media Service. externalDocs: url: https://aka.ms/media-manage x-ms-examples: MediaServiceListKeys: $ref: ./examples/MediaServiceListKeys.json parameters: - $ref: '#/parameters/subscriptionIdParameter_5' - $ref: '#/parameters/apiVersionParameter_5' - $ref: '#/parameters/resourceGroupNameParameter_5' - $ref: '#/parameters/mediaResourceNameParameter' responses: '200': description: Success. The keys for the Media Services account were listed. schema: $ref: '#/definitions/ServiceKeys' examples: application/json: primaryAuthEndpoint: https://wamsprodglobal001acs.accesscontrol.windows.net/ secondaryAuthEndpoint: https://wamsprodglobal002acs.accesscontrol.windows.net/ primaryKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= secondaryKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= scope: urn:windowsazuremediaservices default: description: List Media Service keys failed. schema: $ref: '#/definitions/ApiError_3' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename Listkeys tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/syncStorageKeys : post: operationId: microsoftAzureMediaserviceSyncstoragekeys description: Synchronizes storage account keys for a storage account associated with the Media Service account. externalDocs: url: https://aka.ms/media-manage x-ms-examples: MediaServiceSyncStorageKeys: $ref: ./examples/MediaServiceSyncStorageKeys.json parameters: - $ref: '#/parameters/subscriptionIdParameter_5' - $ref: '#/parameters/apiVersionParameter_5' - $ref: '#/parameters/resourceGroupNameParameter_5' - $ref: '#/parameters/mediaResourceNameParameter' - name: parameters description: Properties needed to synchronize the keys for a storage account to the Media Service. in: body required: true schema: $ref: '#/definitions/SyncStorageKeysInput' responses: '200': description: Success. The keys for the storage account were synchronized. default: description: Synch Media Service storage keys failed. schema: $ref: '#/definitions/ApiError_3' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Media Mediaservices Mediaservicename Syncstoragekeys tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes: get: description: Gets a list of all Azure Arc PrivateLinkScopes within a subscription. operationId: microsoftAzurePrivatelinkscopesList parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: A list containing 0 or more Azure Arc PrivateLinkScope definitions. schema: $ref: '#/definitions/KubernetesConfigurationPrivateLinkScopeListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopesList.json: $ref: ./examples/PrivateLinkScopesList.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Kubernetesconfiguration Privatelinkscopes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes : get: description: Gets a list of Azure Arc PrivateLinkScopes within a resource group. operationId: microsoftAzurePrivatelinkscopesListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: A list containing 0 or more Azure Arc PrivateLinkScope definitions. schema: $ref: '#/definitions/KubernetesConfigurationPrivateLinkScopeListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopeListByResourceGroup: $ref: ./examples/PrivateLinkScopesListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/{scopeName} : delete: description: Deletes a Azure Arc PrivateLinkScope. operationId: microsoftAzurePrivatelinkscopesDelete parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName' responses: '200': description: Successful request when deleting an Azure Arc PrivateLinkScope. '202': description: Accepted. '204': description: The specified PrivateLinkScope does not exist. 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-examples: PrivateLinkScopesDelete: $ref: ./examples/PrivateLinkScopesDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes Scopename tags: - Subscriptions get: description: Returns a Azure Arc PrivateLinkScope. operationId: microsoftAzurePrivatelinkscopesGet parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName' responses: '200': description: Azure Arc PrivateLinkScope definition. schema: $ref: '#/definitions/KubernetesConfigurationPrivateLinkScope' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopeGet: $ref: ./examples/PrivateLinkScopesGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes Scopename tags: - Subscriptions put: description: 'Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.' operationId: microsoftAzurePrivatelinkscopesCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName' - name: parameters description: Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope. in: body required: true schema: $ref: '#/definitions/KubernetesConfigurationPrivateLinkScope' responses: '200': description: Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope is returned. schema: $ref: '#/definitions/KubernetesConfigurationPrivateLinkScope' '201': description: Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope was created and is returned. schema: $ref: '#/definitions/KubernetesConfigurationPrivateLinkScope' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopeCreate: $ref: ./examples/PrivateLinkScopesCreate.json PrivateLinkScopeUpdate: $ref: ./examples/PrivateLinkScopesUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes Scopename tags: - Subscriptions patch: description: Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method. operationId: microsoftAzurePrivatelinkscopesUpdatetags parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName' - name: PrivateLinkScopeTags description: Updated tag information to set into the PrivateLinkScope instance. in: body required: true schema: $ref: '#/definitions/TagsResource_4' responses: '200': description: Updating the Azure Arc PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties. schema: $ref: '#/definitions/KubernetesConfigurationPrivateLinkScope' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkScopeUpdateTagsOnly: $ref: ./examples/PrivateLinkScopesUpdateTagsOnly.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes Scopename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors : get: tags: - Subscriptions operationId: microsoftAzureAzuredevopsconnectorListbyresourcegroup produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsConnectorListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: AzureDevOpsConnector_ListByResourceGroup: $ref: ./examples/AzureDevOpsConnectorListByResourceGroup.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securitydevops Azuredevopsconnectors description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName} : get: tags: - Subscriptions summary: Microsoft Azure Returns A Monitored Azuredevops Connector Resource For A Given Id operationId: microsoftAzureAzuredevopsconnectorGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsConnector' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: AzureDevOpsConnector_Get: $ref: ./examples/AzureDevOpsConnectorGet.json description: Needs a more full description created. put: tags: - Subscriptions summary: Microsoft Azure Creates Or Updates An Azure Devops Connector operationId: microsoftAzureAzuredevopsconnectorCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: azureDevOpsConnector description: Connector resource payload. required: true schema: $ref: '#/definitions/AzureDevOpsConnector' responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsConnector' '201': description: Created schema: $ref: '#/definitions/AzureDevOpsConnector' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/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: AzureDevOpsConnector_CreateOrUpdate: $ref: ./examples/AzureDevOpsConnectorCreateOrUpdate.json description: Needs a more full description created. patch: tags: - Subscriptions summary: Microsoft Azure Update Monitored Azuredevops Connector Details operationId: microsoftAzureAzuredevopsconnectorUpdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: azureDevOpsConnector description: Connector resource payload. schema: $ref: '#/definitions/AzureDevOpsConnector' responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsConnector' '202': description: Accepted schema: $ref: '#/definitions/AzureDevOpsConnector' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: AzureDevOpsConnector_Update: $ref: ./examples/AzureDevOpsConnectorUpdate.json description: Needs a more full description created. delete: tags: - Subscriptions summary: Microsoft Azure Delete Monitored Azuredevops Connector Details operationId: microsoftAzureAzuredevopsconnectorDelete produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: AzureDevOpsConnector_Delete: $ref: ./examples/AzureDevOpsConnectorDelete.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/repos : get: tags: - Subscriptions operationId: microsoftAzureAzuredevopsrepoListbyconnector produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsRepoListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: AzureDevOpsRepo_ListByConnector: $ref: ./examples/AzureDevOpsRepoListByConnector.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securitydevops Azuredevopsconnectors Azuredevopsconnectorname Repos description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/stats : get: tags: - Subscriptions summary: Microsoft Azure Returns The Summary Of The Azuredevops Connector Stats operationId: microsoftAzureAzuredevopsconnectorstatsGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsConnectorStatsListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: AzureDevOpsConnectorStats_Get: $ref: ./examples/AzureDevOpsConnectorStatsGet.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs : get: tags: - Subscriptions operationId: microsoftAzureAzuredevopsorgList produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsOrgListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: AzureDevOpsOrg_List: $ref: ./examples/AzureDevOpsOrgList.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securitydevops Azuredevopsconnectors Azuredevopsconnectorname Orgs description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs/{azureDevOpsOrgName} : get: tags: - Subscriptions summary: Microsoft Azure Returns A Monitored Azuredevops Org Resource For A Given Id operationId: microsoftAzureAzuredevopsorgGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsOrg' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: AzureDevOpsOrg_Get: $ref: ./examples/AzureDevOpsOrgGet.json description: Needs a more full description created. put: tags: - Subscriptions summary: Microsoft Azure Creates Or Updates An Azure Devops Org operationId: microsoftAzureAzuredevopsorgCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: azureDevOpsOrg description: Azure DevOps Org resource payload. required: true schema: $ref: '#/definitions/AzureDevOpsOrg' responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsOrg' '201': description: Created schema: $ref: '#/definitions/AzureDevOpsOrg' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/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: AzureDevOpsOrg_CreateOrUpdate: $ref: ./examples/AzureDevOpsOrgCreateOrUpdate.json description: Needs a more full description created. patch: tags: - Subscriptions summary: Microsoft Azure Update Monitored Azuredevops Org Details operationId: microsoftAzureAzuredevopsorgUpdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: azureDevOpsOrg description: Azure DevOps Org resource payload. schema: $ref: '#/definitions/AzureDevOpsOrg' responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsOrg' '202': description: Accepted schema: $ref: '#/definitions/AzureDevOpsOrg' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: AzureDevOpsOrg_Update: $ref: ./examples/AzureDevOpsOrgUpdate.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs/{azureDevOpsOrgName}/projects : get: tags: - Subscriptions operationId: microsoftAzureAzuredevopsprojectList produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsProjectListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: AzureDevOpsProject_List: $ref: ./examples/AzureDevOpsProjectList.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securitydevops Azuredevopsconnectors Azuredevopsconnectorname Orgs Azuredevopsorgname Projects description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs/{azureDevOpsOrgName}/projects/{azureDevOpsProjectName} : get: tags: - Subscriptions summary: Microsoft Azure Returns A Monitored Azuredevops Project Resource For A Given Id operationId: microsoftAzureAzuredevopsprojectGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: '#/parameters/AzureDevOpsProjectName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsProject' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: AzureDevOpsProject_Get: $ref: ./examples/AzureDevOpsProjectGet.json description: Needs a more full description created. put: tags: - Subscriptions summary: Microsoft Azure Creates Or Updates An Azure Devops Project operationId: microsoftAzureAzuredevopsprojectCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: '#/parameters/AzureDevOpsProjectName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: azureDevOpsProject description: Azure DevOps Org resource payload. required: true schema: $ref: '#/definitions/AzureDevOpsProject' responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsProject' '201': description: Created schema: $ref: '#/definitions/AzureDevOpsProject' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/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: AzureDevOpsProject_CreateOrUpdate: $ref: ./examples/AzureDevOpsProjectCreateOrUpdate.json description: Needs a more full description created. patch: tags: - Subscriptions summary: Microsoft Azure Update Monitored Azuredevops Project Details operationId: microsoftAzureAzuredevopsprojectUpdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: '#/parameters/AzureDevOpsProjectName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: azureDevOpsProject description: Azure DevOps Project resource payload. schema: $ref: '#/definitions/AzureDevOpsProject' responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsProject' '202': description: Accepted schema: $ref: '#/definitions/AzureDevOpsProject' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: AzureDevOpsProject_Update: $ref: ./examples/AzureDevOpsProjectUpdate.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs/{azureDevOpsOrgName}/projects/{azureDevOpsProjectName}/repos : get: tags: - Subscriptions operationId: microsoftAzureAzuredevopsrepoList produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: '#/parameters/AzureDevOpsProjectName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsRepoListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: AzureDevOpsRepo_List: $ref: ./examples/AzureDevOpsRepoList.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securitydevops Azuredevopsconnectors Azuredevopsconnectorname Orgs Azuredevopsorgname Projects Azuredevopsprojectname Repos description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors/{azureDevOpsConnectorName}/orgs/{azureDevOpsOrgName}/projects/{azureDevOpsProjectName}/repos/{azureDevOpsRepoName} : get: tags: - Subscriptions summary: Microsoft Azure Returns A Monitored Azuredevops Project Resource For A Given Id operationId: microsoftAzureAzuredevopsrepoGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: '#/parameters/AzureDevOpsProjectName' - $ref: '#/parameters/AzureDevOpsRepoName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsRepo' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: AzureDevOpsRepo_Get: $ref: ./examples/AzureDevOpsRepoGet.json description: Needs a more full description created. put: tags: - Subscriptions summary: Microsoft Azure Updates An Azure Devops Repo operationId: microsoftAzureAzuredevopsrepoCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: '#/parameters/AzureDevOpsProjectName' - $ref: '#/parameters/AzureDevOpsRepoName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: azureDevOpsRepo description: Azure DevOps Repo resource payload. required: true schema: $ref: '#/definitions/AzureDevOpsRepo' responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsRepo' '201': description: Created schema: $ref: '#/definitions/AzureDevOpsRepo' '202': description: Accepted schema: $ref: '#/definitions/AzureDevOpsRepo' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/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: AzureDevOpsRepo_CreateOrUpdate: $ref: ./examples/AzureDevOpsRepoCreateOrUpdate.json description: Needs a more full description created. patch: tags: - Subscriptions summary: Microsoft Azure Update Monitored Azuredevops Repo Details operationId: microsoftAzureAzuredevopsrepoUpdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/AzureDevOpsConnectorName' - $ref: '#/parameters/AzureDevOpsOrgName' - $ref: '#/parameters/AzureDevOpsProjectName' - $ref: '#/parameters/AzureDevOpsRepoName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: azureDevOpsRepo description: Azure DevOps Repo resource payload. schema: $ref: '#/definitions/AzureDevOpsRepo' responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsRepo' '202': description: Accepted schema: $ref: '#/definitions/AzureDevOpsRepo' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: AzureDevOpsRepo_Update: $ref: ./examples/AzureDevOpsRepoUpdate.json description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors: get: tags: - Subscriptions operationId: microsoftAzureGithubconnectorListbyresourcegroup produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/GitHubConnectorListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: GitHubConnector_ListByResourceGroup: $ref: ./examples/GitHubConnectorListByResourceGroup.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securitydevops Githubconnectors description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName} : get: tags: - Subscriptions summary: Microsoft Azure Returns A Monitored Github Connector Resource For A Given Id operationId: microsoftAzureGithubconnectorGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/GitHubConnector' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: GitHubConnector_Get: $ref: ./examples/GitHubConnectorGet.json description: Needs a more full description created. put: tags: - Subscriptions summary: Microsoft Azure Create Or Update A Monitored Github Connector Resource operationId: microsoftAzureGithubconnectorCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: gitHubConnector description: Connector resource payload. required: true schema: $ref: '#/definitions/GitHubConnector' responses: '200': description: Success schema: $ref: '#/definitions/GitHubConnector' '201': description: Created schema: $ref: '#/definitions/GitHubConnector' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/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: GitHubConnector_CreateOrUpdate: $ref: ./examples/GitHubConnectorCreateOrUpdate.json description: Needs a more full description created. patch: tags: - Subscriptions summary: Microsoft Azure Update Monitored Github Connector Details operationId: microsoftAzureGithubconnectorUpdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: gitHubConnector description: Connector resource payload. schema: $ref: '#/definitions/GitHubConnector' responses: '200': description: Success schema: $ref: '#/definitions/GitHubConnector' '202': description: Accepted schema: $ref: '#/definitions/GitHubConnector' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: GitHubConnector_Update: $ref: ./examples/GitHubConnectorUpdate.json description: Needs a more full description created. delete: tags: - Subscriptions summary: Microsoft Azure Delete Monitored Github Connector Details operationId: microsoftAzureGithubconnectorDelete produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: GitHubConnector_Delete: $ref: ./examples/GitHubConnectorDelete.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/repos : get: tags: - Subscriptions summary: Microsoft Azure Returns A List Of Monitored Github Repositories operationId: microsoftAzureGithubrepoListbyconnector produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/GitHubRepoListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: GitHubRepo_ListByConnector: $ref: ./examples/GitHubRepoListByConnector.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/stats : get: tags: - Subscriptions summary: Microsoft Azure Returns The Summary Of The Github Connector Stats operationId: microsoftAzureGithubconnectorstatsGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/GitHubConnectorStatsListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: GitHubConnectorStats_Get: $ref: ./examples/GitHubConnectorStatsGet.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/owners : get: tags: - Subscriptions summary: Microsoft Azure Returns A List Of Monitored Github Owners operationId: microsoftAzureGithubownerList produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/GitHubOwnerListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: GitHubOwner_List: $ref: ./examples/GitHubOwnerList.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/owners/{gitHubOwnerName} : get: tags: - Subscriptions summary: Microsoft Azure Returns A Monitored Github Repository operationId: microsoftAzureGithubownerGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: '#/parameters/GitHubOwnerName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/GitHubOwner' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: GitHubOwner_Get: $ref: ./examples/GitHubOwnerGet.json description: Needs a more full description created. put: tags: - Subscriptions summary: Microsoft Azure Create Or Update A Monitored Github Owner operationId: microsoftAzureGithubownerCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: '#/parameters/GitHubOwnerName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: gitHubOwner description: Github owner. required: true schema: $ref: '#/definitions/GitHubOwner' responses: '200': description: Success schema: $ref: '#/definitions/GitHubOwner' '201': description: Created schema: $ref: '#/definitions/GitHubOwner' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/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: GitHubOwner_CreateOrUpdate: $ref: ./examples/GitHubOwnerCreateOrUpdate.json description: Needs a more full description created. patch: tags: - Subscriptions summary: Microsoft Azure Update A Monitored Github Repository operationId: microsoftAzureGithubownerUpdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: '#/parameters/GitHubOwnerName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: gitHubOwner description: Github owner. schema: $ref: '#/definitions/GitHubOwner' responses: '200': description: Success schema: $ref: '#/definitions/GitHubOwner' '202': description: Accepted schema: $ref: '#/definitions/GitHubOwner' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: GitHubOwner_Update: $ref: ./examples/GitHubOwnerUpdate.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/owners/{gitHubOwnerName}/repos : get: tags: - Subscriptions summary: Microsoft Azure Returns A List Of Monitored Github Repositories operationId: microsoftAzureGithubrepoList produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: '#/parameters/GitHubOwnerName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/GitHubRepoListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: GitHubRepo_List: $ref: ./examples/GitHubRepoList.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityDevOps/gitHubConnectors/{gitHubConnectorName}/owners/{gitHubOwnerName}/repos/{gitHubRepoName} : get: tags: - Subscriptions summary: Microsoft Azure Returns A Monitored Github Repository operationId: microsoftAzureGithubrepoGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: '#/parameters/GitHubOwnerName' - $ref: '#/parameters/GitHubRepoName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/GitHubRepo' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: GitHubRepo_Get: $ref: ./examples/GitHubRepoGet.json description: Needs a more full description created. put: tags: - Subscriptions summary: Microsoft Azure Create Or Update A Monitored Github Repository operationId: microsoftAzureGithubrepoCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: '#/parameters/GitHubOwnerName' - $ref: '#/parameters/GitHubRepoName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: gitHubRepo description: Github repo. required: true schema: $ref: '#/definitions/GitHubRepo' responses: '200': description: Success schema: $ref: '#/definitions/GitHubRepo' '201': description: Created schema: $ref: '#/definitions/GitHubRepo' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/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: GitHubRepo_CreateOrUpdate: $ref: ./examples/GitHubRepoCreateOrUpdate.json description: Needs a more full description created. patch: tags: - Subscriptions summary: Microsoft Azure Update A Monitored Github Repository operationId: microsoftAzureGithubrepoUpdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/GitHubConnectorName' - $ref: '#/parameters/GitHubOwnerName' - $ref: '#/parameters/GitHubRepoName' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: gitHubRepo description: Github repo. schema: $ref: '#/definitions/GitHubRepo' responses: '200': description: Success schema: $ref: '#/definitions/GitHubRepo' '202': description: Accepted schema: $ref: '#/definitions/GitHubRepo' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: GitHubRepo_Update: $ref: ./examples/GitHubRepoUpdate.json description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.SecurityDevOps/gitHubConnectors: get: tags: - Subscriptions summary: Microsoft Azure Returns A List Of Monitored Github Connectors operationId: microsoftAzureGithubconnectorListbysubscription produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/GitHubConnectorListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: GitHubConnector_ListBySubscription: $ref: ./examples/GitHubConnectorListBySubscription.json description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.SecurityDevOps/azureDevOpsConnectors: get: tags: - Subscriptions summary: Microsoft Azure Returns A List Of Monitored Azuredevops Connectors operationId: microsoftAzureAzuredevopsconnectorListbysubscription produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/AzureDevOpsConnectorListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: AzureDevOpsConnector_ListBySubscription: $ref: ./examples/AzureDevOpsConnectorListBySubscription.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors : get: deprecated: false description: Returns list of connector which connects to the resource, which supports to config the target service during the resource provision. operationId: microsoftAzureConnectorList x-ms-examples: ConnectorList: $ref: ./examples/ConnectorList.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_12' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Connector details. schema: $ref: '#/definitions/ResourceList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Connectors tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName} : get: description: Returns Connector resource for a given name. operationId: microsoftAzureConnectorGet x-ms-examples: Connector: $ref: ./examples/Connectors.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_12' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter - $ref: '#/parameters/ConnectorNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Connector details. schema: $ref: '#/definitions/LinkerResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Connectors Connectorname tags: - Subscriptions put: description: Create or update Connector resource. operationId: microsoftAzureConnectorCreateorupdate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: PutConnector: $ref: ./examples/PutConnector.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_12' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter - $ref: '#/parameters/ConnectorNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: parameters description: Connector details. in: body required: true schema: $ref: '#/definitions/LinkerResource' responses: '200': description: Successful. schema: $ref: '#/definitions/LinkerResource' '201': description: Long running operation. schema: $ref: '#/definitions/LinkerResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicelinker Locations Location Connectors Connectorname tags: - Subscriptions /subscriptions/{subscriptionId}/providers/microsoft.insights/privateLinkScopes: get: description: Gets a list of all Azure Monitor PrivateLinkScopes within a subscription. operationId: microsoftAzurePrivatelinkscopesList parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter responses: '200': description: A list containing 0 or more Azure Monitor PrivateLinkScope definitions. schema: $ref: '#/definitions/AzureMonitorPrivateLinkScopeListResult' default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: PrivateLinkScopesList.json: $ref: ./examples/PrivateLinkScopesList.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Insights Privatelinkscopes tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes: get: description: Gets a list of Azure Monitor PrivateLinkScopes within a resource group. operationId: microsoftAzurePrivatelinkscopesListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter responses: '200': description: A list containing 0 or more Azure Monitor PrivateLinkScope definitions. schema: $ref: '#/definitions/AzureMonitorPrivateLinkScopeListResult' default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: PrivateLinkScopeListByResourceGroup: $ref: ./examples/PrivateLinkScopesListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes/{scopeName} : delete: description: Deletes a Azure Monitor PrivateLinkScope. operationId: microsoftAzurePrivatelinkscopesDelete parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName_2' responses: '200': description: Successful request when deleting a Azure Monitor PrivateLinkScope. '202': description: Accepted. '204': description: The specified PrivateLinkScope does not exist. default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-long-running-operation: true x-ms-examples: PrivateLinkScopesDelete: $ref: ./examples/PrivateLinkScopesDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes Scopename tags: - Subscriptions get: description: Returns a Azure Monitor PrivateLinkScope. operationId: microsoftAzurePrivatelinkscopesGet parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName_2' responses: '200': description: An Azure Monitor PrivateLinkScope definition. schema: $ref: '#/definitions/AzureMonitorPrivateLinkScope' default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: PrivateLinkScopeGet: $ref: ./examples/PrivateLinkScopesGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes Scopename tags: - Subscriptions put: description: 'Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.' operationId: microsoftAzurePrivatelinkscopesCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName_2' - name: AzureMonitorPrivateLinkScopePayload description: Properties that need to be specified to create or update a Azure Monitor PrivateLinkScope. in: body required: true schema: $ref: '#/definitions/AzureMonitorPrivateLinkScope' responses: '200': description: Successful request when creating or updating a Azure Monitor PrivateLinkScope. The updated PrivateLinkScope is returned. schema: $ref: '#/definitions/AzureMonitorPrivateLinkScope' '201': description: Successful request when creating or updating a Azure Monitor PrivateLinkScope. The updated PrivateLinkScope was created and is returned. schema: $ref: '#/definitions/AzureMonitorPrivateLinkScope' default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: PrivateLinkScopeCreate: $ref: ./examples/PrivateLinkScopesCreate.json PrivateLinkScopeUpdate: $ref: ./examples/PrivateLinkScopesUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes Scopename tags: - Subscriptions patch: description: Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method. operationId: microsoftAzurePrivatelinkscopesUpdatetags parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/PrivateLinkScopeName_2' - name: PrivateLinkScopeTags description: Updated tag information to set into the PrivateLinkScope instance. in: body required: true schema: $ref: '#/definitions/TagsResource_5' responses: '200': description: Updating the Azure Monitor PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties. schema: $ref: '#/definitions/AzureMonitorPrivateLinkScope' default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: PrivateLinkScopeUpdateTagsOnly: $ref: ./examples/PrivateLinkScopesUpdateTagsOnly.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes Scopename tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/bareMetalMachines: get: description: Get a list of bare metal machines in the provided subscription. summary: Microsoft Azure List Bare Metal Machines In The Subscription operationId: microsoftAzureBaremetalmachinesListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/BareMetalMachineList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List bare metal machines for subscription: $ref: ./examples/BareMetalMachines_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/cloudServicesNetworks: get: description: Get a list of cloud services networks in the provided subscription. summary: Microsoft Azure List Cloud Services Networks In The Subscription operationId: microsoftAzureCloudservicesnetworksListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/CloudServicesNetworkList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List cloud services networks for subscription: $ref: ./examples/CloudServicesNetworks_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/clusterManagers: get: description: Get a list of cluster managers in the provided subscription. summary: Microsoft Azure List Cluster Managers In The Subscription operationId: microsoftAzureClustermanagersListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/ClusterManagerList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List cluster managers for subscription: $ref: ./examples/ClusterManagers_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/clusters: get: description: Get a list of clusters in the provided subscription. summary: Microsoft Azure List Clusters In The Subscription operationId: microsoftAzureClustersListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/ClusterList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List clusters for subscription: $ref: ./examples/Clusters_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/kubernetesClusters: get: description: Get a list of Kubernetes clusters in the provided subscription. summary: Microsoft Azure List Kubernetes Clusters In The Subscription operationId: microsoftAzureKubernetesclustersListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/KubernetesClusterList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List Kubernetes clusters for subscription: $ref: ./examples/KubernetesClusters_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l2Networks: get: description: Get a list of layer 2 (L2) networks in the provided subscription. summary: Microsoft Azure List Layer 2 L2 Networks In The Subscription operationId: microsoftAzureL2networksListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/L2NetworkList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List L2 networks for subscription: $ref: ./examples/L2Networks_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l3Networks: get: description: Get a list of layer 3 (L3) networks in the provided subscription. summary: Microsoft Azure List Layer 3 L3 Networks In The Subscription operationId: microsoftAzureL3networksListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/L3NetworkList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List L3 networks for subscription: $ref: ./examples/L3Networks_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/rackSkus: get: description: Get a list of rack SKUs in the provided subscription. summary: Microsoft Azure List Rack Skus In The Subscription operationId: microsoftAzureRackskusListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/RackSkuList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List rack SKUs for subscription: $ref: ./examples/RackSkus_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/rackSkus/{rackSkuName}: get: description: Get the properties of the provided rack SKU. summary: Microsoft Azure Retrieve The Rack Sku operationId: microsoftAzureRackskusGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/RackSkuNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/RackSku' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get rack SKU resource: $ref: ./examples/RackSkus_Get.json tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/racks: get: description: Get a list of racks in the provided subscription. summary: Microsoft Azure List Racks In The Subscription operationId: microsoftAzureRacksListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/RackList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List racks for subscription: $ref: ./examples/Racks_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/storageAppliances: get: description: Get a list of storage appliances in the provided subscription. summary: Microsoft Azure List Storage Appliances In The Subscription operationId: microsoftAzureStorageappliancesListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/StorageApplianceList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List storage appliances for subscription: $ref: ./examples/StorageAppliances_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/trunkedNetworks: get: description: Get a list of trunked networks in the provided subscription. summary: Microsoft Azure List Trunked Networks In The Subscription operationId: microsoftAzureTrunkednetworksListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/TrunkedNetworkList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List trunked networks for subscription: $ref: ./examples/TrunkedNetworks_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/virtualMachines: get: description: Get a list of virtual machines in the provided subscription. summary: Microsoft Azure List Virtual Machines In The Subscription operationId: microsoftAzureVirtualmachinesListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/VirtualMachineList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List virtual machines for subscription: $ref: ./examples/VirtualMachines_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/volumes: get: description: Get a list of volumes in the provided subscription. summary: Microsoft Azure List Volumes In The Subscription operationId: microsoftAzureVolumesListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/VolumeList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List volume for subscription: $ref: ./examples/Volumes_ListBySubscription.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines: get: description: Get a list of bare metal machines in the provided resource group. summary: Microsoft Azure List Bare Metal Machines In The Resource Group operationId: microsoftAzureBaremetalmachinesListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/BareMetalMachineList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List bare metal machines for resource group: $ref: ./examples/BareMetalMachines_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName} : get: description: Get properties of the provided bare metal machine. summary: Microsoft Azure Retrieve The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/BareMetalMachine' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get bare metal machine: $ref: ./examples/BareMetalMachines_Get.json tags: - Subscriptions put: description: Create a new bare metal machine or update the properties of the existing one.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: Microsoft Azure Create Or Update The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' - description: The request body. name: bareMetalMachineParameters in: body required: true schema: $ref: '#/definitions/BareMetalMachine' responses: '200': description: OK schema: $ref: '#/definitions/BareMetalMachine' '201': description: Created schema: $ref: '#/definitions/BareMetalMachine' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update bare metal machine: $ref: ./examples/BareMetalMachines_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided bare metal machine.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: Microsoft Azure Delete The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete bare metal machine: $ref: ./examples/BareMetalMachines_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently. summary: Microsoft Azure Patch The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' - description: The request body. name: bareMetalMachineUpdateParameters in: body schema: $ref: '#/definitions/BareMetalMachinePatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/BareMetalMachine' '202': description: Accepted schema: $ref: '#/definitions/BareMetalMachine' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch bare metal machine: $ref: ./examples/BareMetalMachines_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/cordon : post: description: Cordon the provided bare metal machine's Kubernetes node. summary: Microsoft Azure Cordon The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesCordon parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' - description: The request body. name: bareMetalMachineCordonParameters in: body schema: $ref: '#/definitions/BareMetalMachineCordonParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Cordon bare metal machine: $ref: ./examples/BareMetalMachines_Cordon.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/powerOff : post: description: Power off the provided bare metal machine. summary: Microsoft Azure Power Off The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesPoweroff parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' - description: The request body. name: bareMetalMachinePowerOffParameters in: body schema: $ref: '#/definitions/BareMetalMachinePowerOffParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Power off bare metal machine: $ref: ./examples/BareMetalMachines_PowerOff.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/reimage : post: description: Reimage the provided bare metal machine. summary: Microsoft Azure Reimage The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesReimage parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Reimage bare metal machine: $ref: ./examples/BareMetalMachines_Reimage.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/replace : post: description: Replace the provided bare metal machine. summary: Microsoft Azure Replace Service The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesReplace parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' - description: The request body. name: bareMetalMachineReplaceParameters in: body schema: $ref: '#/definitions/BareMetalMachineReplaceParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Replace bare metal machine: $ref: ./examples/BareMetalMachines_Replace.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/restart : post: description: Restart the provided bare metal machine. summary: Microsoft Azure Restart The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesRestart parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Restart bare metal machine: $ref: ./examples/BareMetalMachines_Restart.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runCommand : post: description: Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. summary: Microsoft Azure Run The Command On The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesRuncommand parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' - description: The request body. name: bareMetalMachineRunCommandParameters in: body required: true schema: $ref: '#/definitions/BareMetalMachineRunCommandParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Run command on bare metal machine: $ref: ./examples/BareMetalMachines_RunCommand.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runDataExtracts : post: description: Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. summary: Microsoft Azure Run Data Extraction For A Bare Metal Machine operationId: microsoftAzureBaremetalmachinesRundataextracts parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' - description: The request body. name: bareMetalMachineRunDataExtractsParameters in: body required: true schema: $ref: '#/definitions/BareMetalMachineRunDataExtractsParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Run data extraction on bare metal machine: $ref: ./examples/BareMetalMachines_RunDataExtracts.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runReadCommands : post: description: Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. summary: Microsoft Azure Run Read Only Commands Against A Bare Metal Machine operationId: microsoftAzureBaremetalmachinesRunreadcommands parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' - description: The request body. name: bareMetalMachineRunReadCommandsParameters in: body required: true schema: $ref: '#/definitions/BareMetalMachineRunReadCommandsParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Run and retrieve output from read only commands on bare metal machine.: $ref: ./examples/BareMetalMachines_RunReadCommands.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/start : post: description: Start the provided bare metal machine. summary: Microsoft Azure Start The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesStart parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Start bare metal machine: $ref: ./examples/BareMetalMachines_Start.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/uncordon : post: description: Uncordon the provided bare metal machine's Kubernetes node. summary: Microsoft Azure Uncordon The Bare Metal Machine operationId: microsoftAzureBaremetalmachinesUncordon parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/BareMetalMachineNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Uncordon bare metal machine: $ref: ./examples/BareMetalMachines_Uncordon.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks: get: description: Get a list of cloud services networks in the provided resource group. summary: Microsoft Azure List Cloud Services Networks In The Resource Group operationId: microsoftAzureCloudservicesnetworksListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/CloudServicesNetworkList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List cloud services networks for resource group: $ref: ./examples/CloudServicesNetworks_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks/{cloudServicesNetworkName} : get: description: Get properties of the provided cloud services network. summary: Microsoft Azure Retrieve The Cloud Services Network operationId: microsoftAzureCloudservicesnetworksGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/CloudServicesNetworkNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/CloudServicesNetwork' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get cloud services network: $ref: ./examples/CloudServicesNetworks_Get.json tags: - Subscriptions put: description: Create a new cloud services network or update the properties of the existing cloud services network. summary: Microsoft Azure Create Or Update The Cloud Services Network operationId: microsoftAzureCloudservicesnetworksCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/CloudServicesNetworkNameParameter' - description: The request body. name: cloudServicesNetworkParameters in: body required: true schema: $ref: '#/definitions/CloudServicesNetwork' responses: '200': description: OK schema: $ref: '#/definitions/CloudServicesNetwork' '201': description: Created schema: $ref: '#/definitions/CloudServicesNetwork' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update cloud services network: $ref: ./examples/CloudServicesNetworks_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided cloud services network. summary: Microsoft Azure Delete The Cloud Services Network operationId: microsoftAzureCloudservicesnetworksDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/CloudServicesNetworkNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete cloud services network: $ref: ./examples/CloudServicesNetworks_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Update properties of the provided cloud services network, or update the tags associated with it. Properties and tag updates can be done independently. summary: Microsoft Azure Patch The Cloud Services Network operationId: microsoftAzureCloudservicesnetworksUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/CloudServicesNetworkNameParameter' - description: The request body. name: cloudServicesNetworkUpdateParameters in: body schema: $ref: '#/definitions/CloudServicesNetworkPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/CloudServicesNetwork' '202': description: Accepted schema: $ref: '#/definitions/CloudServicesNetwork' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch cloud services network: $ref: ./examples/CloudServicesNetworks_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers: get: description: Get a list of cluster managers in the provided resource group. summary: Microsoft Azure List Cluster Managers In The Resource Group operationId: microsoftAzureClustermanagersListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/ClusterManagerList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List cluster managers for resource group: $ref: ./examples/ClusterManagers_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName} : get: description: Get the properties of the provided cluster manager. summary: Microsoft Azure Retrieve The Cluster Manager operationId: microsoftAzureClustermanagersGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterManagerNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/ClusterManager' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get cluster manager: $ref: ./examples/ClusterManagers_Get.json tags: - Subscriptions put: description: Create a new cluster manager or update properties of the cluster manager if it exists. summary: Microsoft Azure Create Or Update The Cluster Manager operationId: microsoftAzureClustermanagersCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterManagerNameParameter' - description: The request body. name: clusterManagerParameters in: body required: true schema: $ref: '#/definitions/ClusterManager' responses: '200': description: OK schema: $ref: '#/definitions/ClusterManager' '201': description: Created schema: $ref: '#/definitions/ClusterManager' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update cluster manager: $ref: ./examples/ClusterManagers_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided cluster manager. summary: Microsoft Azure Delete The Cluster Manager operationId: microsoftAzureClustermanagersDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterManagerNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete cluster manager: $ref: ./examples/ClusterManagers_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently. summary: Microsoft Azure Patch The Cluster Manager operationId: microsoftAzureClustermanagersUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterManagerNameParameter' - description: The request body. name: clusterManagerUpdateParameters in: body schema: $ref: '#/definitions/ClusterManagerPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/ClusterManager' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch cluster manager: $ref: ./examples/ClusterManagers_Patch.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters: get: description: Get a list of clusters in the provided resource group. summary: Microsoft Azure List Clusters In The Resource Group operationId: microsoftAzureClustersListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/ClusterList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List clusters for resource group: $ref: ./examples/Clusters_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}: get: description: Get properties of the provided cluster. summary: Microsoft Azure Retrieve The Cluster operationId: microsoftAzureClustersGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' responses: '200': description: OK schema: $ref: '#/definitions/Cluster_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get cluster: $ref: ./examples/Clusters_Get.json tags: - Subscriptions put: description: Create a new cluster or update the properties of the cluster if it exists. summary: Microsoft Azure Create Or Update The Cluster operationId: microsoftAzureClustersCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - description: The request body. name: clusterParameters in: body required: true schema: $ref: '#/definitions/Cluster_2' responses: '200': description: OK schema: $ref: '#/definitions/Cluster_2' '201': description: Created schema: $ref: '#/definitions/Cluster_2' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update cluster: $ref: ./examples/Clusters_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided cluster. summary: Microsoft Azure Delete The Cluster operationId: microsoftAzureClustersDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete cluster: $ref: ./examples/Clusters_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently. summary: Microsoft Azure Patch The Cluster operationId: microsoftAzureClustersUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - description: The request body. name: clusterUpdateParameters in: body schema: $ref: '#/definitions/ClusterPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/Cluster_2' '202': description: Accepted schema: $ref: '#/definitions/Cluster_2' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch cluster AggregatorOrSingleRackDefinition: $ref: ./examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json Patch cluster location: $ref: ./examples/Clusters_Patch_Location.json Patch runtime protection configuration: $ref: ./examples/Clusters_Patch_RuntimeProtectionConfiguration.json Patch secret archive: $ref: ./examples/Clusters_Patch_SecretArchive.json Patch update strategy: $ref: ./examples/Clusters_Patch_UpdateStrategy.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets : get: description: Get a list of bare metal machine key sets for the provided cluster. summary: Microsoft Azure List Bare Metal Machine Key Sets Of The Cluster operationId: microsoftAzureBaremetalmachinekeysetsListbycluster parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' responses: '200': description: OK schema: $ref: '#/definitions/BareMetalMachineKeySetList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List bare metal machine key sets of the cluster: $ref: ./examples/BareMetalMachineKeySets_ListByCluster.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets/{bareMetalMachineKeySetName} : get: description: Get bare metal machine key set of the provided cluster. summary: Microsoft Azure Retrieve The Bare Metal Machine Key Set Of The Cluster operationId: microsoftAzureBaremetalmachinekeysetsGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/BareMetalMachineKeySetNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/BareMetalMachineKeySet' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get bare metal machine key set of cluster: $ref: ./examples/BareMetalMachineKeySets_Get.json tags: - Subscriptions put: description: Create a new bare metal machine key set or update the existing one for the provided cluster. summary: Microsoft Azure Create Or Update The Bare Metal Machine Key Set Of The Cluster operationId: microsoftAzureBaremetalmachinekeysetsCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/BareMetalMachineKeySetNameParameter' - description: The request body. name: bareMetalMachineKeySetParameters in: body required: true schema: $ref: '#/definitions/BareMetalMachineKeySet' responses: '200': description: OK schema: $ref: '#/definitions/BareMetalMachineKeySet' '201': description: Created schema: $ref: '#/definitions/BareMetalMachineKeySet' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update bare metal machine key set of cluster: $ref: ./examples/BareMetalMachineKeySets_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the bare metal machine key set of the provided cluster. summary: Microsoft Azure Delete The Bare Metal Machine Key Set Of The Cluster operationId: microsoftAzureBaremetalmachinekeysetsDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/BareMetalMachineKeySetNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete bare metal machine key set of cluster: $ref: ./examples/BareMetalMachineKeySets_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch properties of bare metal machine key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently. summary: Microsoft Azure Patch Bare Metal Machine Key Set Of The Cluster operationId: microsoftAzureBaremetalmachinekeysetsUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/BareMetalMachineKeySetNameParameter' - description: The request body. name: bareMetalMachineKeySetUpdateParameters in: body schema: $ref: '#/definitions/BareMetalMachineKeySetPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/BareMetalMachineKeySet' '202': description: Accepted schema: $ref: '#/definitions/BareMetalMachineKeySet' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch bare metal machine key set of cluster: $ref: ./examples/BareMetalMachineKeySets_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets : get: description: Get a list of baseboard management controller key sets for the provided cluster. summary: Microsoft Azure List Baseboard Management Controller Key Sets Of The Cluster operationId: microsoftAzureBmckeysetsListbycluster parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' responses: '200': description: OK schema: $ref: '#/definitions/BmcKeySetList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List baseboard management controller key sets of the cluster: $ref: ./examples/BmcKeySets_ListByCluster.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets/{bmcKeySetName} : get: description: Get baseboard management controller key set of the provided cluster. summary: Microsoft Azure Retrieve The Baseboard Management Controller Key Set Of The Cluster operationId: microsoftAzureBmckeysetsGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/BmcKeySetNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/BmcKeySet' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get baseboard management controller key set of cluster: $ref: ./examples/BmcKeySets_Get.json tags: - Subscriptions put: description: Create a new baseboard management controller key set or update the existing one for the provided cluster. summary: Microsoft Azure Create Or Update The Baseboard Management Controller Key Set Of The Cluster operationId: microsoftAzureBmckeysetsCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/BmcKeySetNameParameter' - description: The request body. name: bmcKeySetParameters in: body required: true schema: $ref: '#/definitions/BmcKeySet' responses: '200': description: OK schema: $ref: '#/definitions/BmcKeySet' '201': description: Created schema: $ref: '#/definitions/BmcKeySet' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update baseboard management controller key set of cluster: $ref: ./examples/BmcKeySets_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the baseboard management controller key set of the provided cluster. summary: Microsoft Azure Delete The Baseboard Management Controller Key Set Of The Cluster operationId: microsoftAzureBmckeysetsDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/BmcKeySetNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete baseboard management controller key set of cluster: $ref: ./examples/BmcKeySets_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch properties of baseboard management controller key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently. summary: Microsoft Azure Patch Baseboard Management Controller Key Set Of The Cluster operationId: microsoftAzureBmckeysetsUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/BmcKeySetNameParameter' - description: The request body. name: bmcKeySetUpdateParameters in: body schema: $ref: '#/definitions/BmcKeySetPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/BmcKeySet' '202': description: Accepted schema: $ref: '#/definitions/BmcKeySet' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch baseboard management controller key set of cluster: $ref: ./examples/BmcKeySets_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/deploy : post: description: Deploy the cluster using the rack configuration provided during creation. summary: Microsoft Azure Deploy The Cluster operationId: microsoftAzureClustersDeploy parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - description: The request body. name: clusterDeployParameters in: body schema: $ref: '#/definitions/ClusterDeployParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Deploy cluster: $ref: ./examples/Clusters_Deploy.json Deploy cluster skipping validation: $ref: ./examples/Clusters_Deploy_SkipValidation.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations : get: description: Get a list of metrics configurations for the provided cluster. summary: Microsoft Azure List Metrics Configurations Of The Cluster operationId: microsoftAzureMetricsconfigurationsListbycluster parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' responses: '200': description: OK schema: $ref: '#/definitions/ClusterMetricsConfigurationList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List metrics configurations of the cluster: $ref: ./examples/ClusterMetricsConfigurations_ListByCluster.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations/{metricsConfigurationName} : get: description: Get metrics configuration of the provided cluster. summary: Microsoft Azure Retrieve The Metrics Configuration Of The Cluster operationId: microsoftAzureMetricsconfigurationsGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/MetricsConfigurationName' responses: '200': description: OK schema: $ref: '#/definitions/ClusterMetricsConfiguration' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get metrics configuration of cluster: $ref: ./examples/ClusterMetricsConfigurations_Get.json tags: - Subscriptions put: description: Create new or update the existing metrics configuration of the provided cluster. summary: Microsoft Azure Create Or Update Metrics Configuration Of The Cluster operationId: microsoftAzureMetricsconfigurationsCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/MetricsConfigurationName' - description: The request body. name: metricsConfigurationParameters in: body required: true schema: $ref: '#/definitions/ClusterMetricsConfiguration' responses: '200': description: OK schema: $ref: '#/definitions/ClusterMetricsConfiguration' '201': description: Created schema: $ref: '#/definitions/ClusterMetricsConfiguration' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update metrics configuration of cluster: $ref: ./examples/ClusterMetricsConfigurations_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the metrics configuration of the provided cluster. summary: Microsoft Azure Delete The Metrics Configuration Of The Cluster operationId: microsoftAzureMetricsconfigurationsDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/MetricsConfigurationName' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete metrics configuration of cluster: $ref: ./examples/ClusterMetricsConfigurations_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently. summary: Microsoft Azure Patch Metrics Configuration Of The Cluster operationId: microsoftAzureMetricsconfigurationsUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - $ref: '#/parameters/MetricsConfigurationName' - description: The request body. name: metricsConfigurationUpdateParameters in: body schema: $ref: '#/definitions/ClusterMetricsConfigurationPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/ClusterMetricsConfiguration' '202': description: Accepted schema: $ref: '#/definitions/ClusterMetricsConfiguration' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch metrics configuration of cluster: $ref: ./examples/ClusterMetricsConfigurations_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/scanRuntime : post: description: Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration. summary: Microsoft Azure Execute A Runtime Protection Scan On The Cluster operationId: microsoftAzureClustersScanruntime parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - description: The request body. name: ClusterScanRuntimeParameters in: body schema: $ref: '#/definitions/ClusterScanRuntimeParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Execute a runtime protection scan on the cluster: $ref: ./examples/Clusters_ScanRuntime.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/updateVersion : post: description: Update the version of the provided cluster to one of the available supported versions. summary: Microsoft Azure Update The Cluster Version operationId: microsoftAzureClustersUpdateversion parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter_3' - description: The request body. name: clusterUpdateVersionParameters in: body required: true schema: $ref: '#/definitions/ClusterUpdateVersionParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Update cluster version: $ref: ./examples/Clusters_UpdateVersion.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters: get: description: Get a list of Kubernetes clusters in the provided resource group. summary: Microsoft Azure List Kubernetes Clusters In The Resource Group operationId: microsoftAzureKubernetesclustersListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/KubernetesClusterList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List Kubernetes clusters for resource group: $ref: ./examples/KubernetesClusters_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName} : get: description: Get properties of the provided the Kubernetes cluster. summary: Microsoft Azure Retrieve The Kubernetes Cluster operationId: microsoftAzureKubernetesclustersGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/KubernetesClusterNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/KubernetesCluster' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get Kubernetes cluster: $ref: ./examples/KubernetesClusters_Get.json tags: - Subscriptions put: description: Create a new Kubernetes cluster or update the properties of the existing one. summary: Microsoft Azure Create Or Update The Kubernetes Cluster operationId: microsoftAzureKubernetesclustersCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/KubernetesClusterNameParameter' - description: The request body. name: kubernetesClusterParameters in: body required: true schema: $ref: '#/definitions/KubernetesCluster' responses: '200': description: OK schema: $ref: '#/definitions/KubernetesCluster' '201': description: Created schema: $ref: '#/definitions/KubernetesCluster' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update Kubernetes cluster: $ref: ./examples/KubernetesClusters_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided Kubernetes cluster. summary: Microsoft Azure Delete The Kubernetes Cluster operationId: microsoftAzureKubernetesclustersDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/KubernetesClusterNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete Kubernetes cluster: $ref: ./examples/KubernetesClusters_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch the properties of the provided Kubernetes cluster, or update the tags associated with the Kubernetes cluster. Properties and tag updates can be done independently. summary: Microsoft Azure Patch The Kubernetes Cluster operationId: microsoftAzureKubernetesclustersUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/KubernetesClusterNameParameter' - description: The request body. name: kubernetesClusterUpdateParameters in: body schema: $ref: '#/definitions/KubernetesClusterPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/KubernetesCluster' '202': description: Accepted schema: $ref: '#/definitions/KubernetesCluster' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch Kubernetes cluster: $ref: ./examples/KubernetesClusters_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools : get: description: Get a list of agent pools for the provided Kubernetes cluster. summary: Microsoft Azure List Agent Pools Of The Kubernetes Cluster operationId: microsoftAzureAgentpoolsListbykubernetescluster parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/KubernetesClusterNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/AgentPoolList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List agent pools of the Kubernetes cluster: $ref: ./examples/AgentPools_ListByKubernetesCluster.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools/{agentPoolName} : get: description: Get properties of the provided Kubernetes cluster agent pool. summary: Microsoft Azure Retrieve The Kubernetes Cluster Agent Pool operationId: microsoftAzureAgentpoolsGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/KubernetesClusterNameParameter' - $ref: '#/parameters/AgentPoolNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/AgentPool' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get Kubernetes cluster agent pool: $ref: ./examples/AgentPools_Get.json tags: - Subscriptions put: description: Create a new Kubernetes cluster agent pool or update the properties of the existing one. summary: Microsoft Azure Create Or Update The Kubernetes Cluster Agent Pool operationId: microsoftAzureAgentpoolsCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/KubernetesClusterNameParameter' - $ref: '#/parameters/AgentPoolNameParameter' - description: The request body. name: agentPoolParameters in: body required: true schema: $ref: '#/definitions/AgentPool' responses: '200': description: OK schema: $ref: '#/definitions/AgentPool' '201': description: Created schema: $ref: '#/definitions/AgentPool' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update Kubernetes cluster agent pool: $ref: ./examples/AgentPools_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided Kubernetes cluster agent pool. summary: Microsoft Azure Delete The Kubernetes Cluster Agent Pool operationId: microsoftAzureAgentpoolsDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/KubernetesClusterNameParameter' - $ref: '#/parameters/AgentPoolNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete Kubernetes cluster agent pool: $ref: ./examples/AgentPools_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently. summary: Microsoft Azure Patch The Kubernetes Cluster Agent Pool operationId: microsoftAzureAgentpoolsUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/KubernetesClusterNameParameter' - $ref: '#/parameters/AgentPoolNameParameter' - description: The request body. name: agentPoolUpdateParameters in: body schema: $ref: '#/definitions/AgentPoolPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/AgentPool' '202': description: Accepted schema: $ref: '#/definitions/AgentPool' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch Kubernetes cluster agent pool: $ref: ./examples/AgentPools_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/restartNode : post: description: Restart a targeted node of a Kubernetes cluster. summary: Microsoft Azure Restart A Targeted Node operationId: microsoftAzureKubernetesclustersRestartnode parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/KubernetesClusterNameParameter' - description: The request body. name: kubernetesClusterRestartNodeParameters in: body required: true schema: $ref: '#/definitions/KubernetesClusterRestartNodeParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Restart a Kubernetes cluster node: $ref: ./examples/KubernetesClusters_RestartNode.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks: get: description: Get a list of layer 2 (L2) networks in the provided resource group. summary: Microsoft Azure List Layer 2 L2 Networks In The Resource Group operationId: microsoftAzureL2networksListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/L2NetworkList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List L2 networks for resource group: $ref: ./examples/L2Networks_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks/{l2NetworkName} : get: description: Get properties of the provided layer 2 (L2) network. summary: Microsoft Azure Retrieve The Layer 2 L2 Network operationId: microsoftAzureL2networksGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/L2NetworkNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/L2Network' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get L2 network: $ref: ./examples/L2Networks_Get.json tags: - Subscriptions put: description: Create a new layer 2 (L2) network or update the properties of the existing network. summary: Microsoft Azure Create Or Update The Layer 2 L2 Network operationId: microsoftAzureL2networksCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/L2NetworkNameParameter' - description: The request body. name: l2NetworkParameters in: body required: true schema: $ref: '#/definitions/L2Network' responses: '200': description: OK schema: $ref: '#/definitions/L2Network' '201': description: Created schema: $ref: '#/definitions/L2Network' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update L2 network: $ref: ./examples/L2Networks_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided layer 2 (L2) network. summary: Microsoft Azure Delete The Layer 2 L2 Network operationId: microsoftAzureL2networksDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/L2NetworkNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete L2 network: $ref: ./examples/L2Networks_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Update tags associated with the provided layer 2 (L2) network. summary: Microsoft Azure Patch The Layer 2 L2 Network operationId: microsoftAzureL2networksUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/L2NetworkNameParameter' - description: The request body. name: l2NetworkUpdateParameters in: body schema: $ref: '#/definitions/L2NetworkPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/L2Network' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch L2 network: $ref: ./examples/L2Networks_Patch.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks: get: description: Get a list of layer 3 (L3) networks in the provided resource group. summary: Microsoft Azure List Layer 3 L3 Networks In The Resource Group operationId: microsoftAzureL3networksListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/L3NetworkList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List L3 networks for resource group: $ref: ./examples/L3Networks_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks/{l3NetworkName} : get: description: Get properties of the provided layer 3 (L3) network. summary: Microsoft Azure Retrieve The Layer 3 L3 Network operationId: microsoftAzureL3networksGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/L3NetworkNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/L3Network' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get L3network: $ref: ./examples/L3Networks_Get.json tags: - Subscriptions put: description: Create a new layer 3 (L3) network or update the properties of the existing network. summary: Microsoft Azure Create Or Update The Layer 3 L3 Network operationId: microsoftAzureL3networksCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/L3NetworkNameParameter' - description: The request body. name: l3NetworkParameters in: body required: true schema: $ref: '#/definitions/L3Network' responses: '200': description: OK schema: $ref: '#/definitions/L3Network' '201': description: Created schema: $ref: '#/definitions/L3Network' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update L3 network: $ref: ./examples/L3Networks_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided layer 3 (L3) network. summary: Microsoft Azure Delete The Layer 3 L3 Network operationId: microsoftAzureL3networksDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/L3NetworkNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete L3 network: $ref: ./examples/L3Networks_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Update tags associated with the provided layer 3 (L3) network. summary: Microsoft Azure Patch The Layer 3 L3 Network operationId: microsoftAzureL3networksUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/L3NetworkNameParameter' - description: The request body. name: l3NetworkUpdateParameters in: body schema: $ref: '#/definitions/L3NetworkPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/L3Network' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch L3 network: $ref: ./examples/L3Networks_Patch.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks: get: description: Get a list of racks in the provided resource group. summary: Microsoft Azure List Racks In The Resource Group operationId: microsoftAzureRacksListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/RackList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List racks for resource group: $ref: ./examples/Racks_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks/{rackName}: get: description: Get properties of the provided rack. summary: Microsoft Azure Retrieve The Rack operationId: microsoftAzureRacksGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/RackNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/Rack' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get rack: $ref: ./examples/Racks_Get.json tags: - Subscriptions put: description: Create a new rack or update properties of the existing one.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: Microsoft Azure Create Or Update The Rack operationId: microsoftAzureRacksCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/RackNameParameter' - description: The request body. name: rackParameters in: body required: true schema: $ref: '#/definitions/Rack' responses: '200': description: OK schema: $ref: '#/definitions/Rack' '201': description: Created schema: $ref: '#/definitions/Rack' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update rack: $ref: ./examples/Racks_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided rack.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: Microsoft Azure Delete The Rack operationId: microsoftAzureRacksDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/RackNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete rack: $ref: ./examples/Racks_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch properties of the provided rack, or update the tags associated with the rack. Properties and tag updates can be done independently. summary: Microsoft Azure Patch The Rack operationId: microsoftAzureRacksUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/RackNameParameter' - description: The request body. name: rackUpdateParameters in: body schema: $ref: '#/definitions/RackPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/Rack' '202': description: Accepted schema: $ref: '#/definitions/Rack' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch rack: $ref: ./examples/Racks_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances: get: description: Get a list of storage appliances in the provided resource group. summary: Microsoft Azure List Storage Appliances In The Resource Group operationId: microsoftAzureStorageappliancesListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/StorageApplianceList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List storage appliances for resource group: $ref: ./examples/StorageAppliances_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName} : get: description: Get properties of the provided storage appliance. summary: Microsoft Azure Retrieve The Storage Appliance operationId: microsoftAzureStorageappliancesGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageApplianceNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/StorageAppliance' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get storage appliance: $ref: ./examples/StorageAppliances_Get.json tags: - Subscriptions put: description: Create a new storage appliance or update the properties of the existing one.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: Microsoft Azure Create Or Update The Storage Appliance operationId: microsoftAzureStorageappliancesCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageApplianceNameParameter' - description: The request body. name: storageApplianceParameters in: body required: true schema: $ref: '#/definitions/StorageAppliance' responses: '200': description: OK schema: $ref: '#/definitions/StorageAppliance' '201': description: Created schema: $ref: '#/definitions/StorageAppliance' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update storage appliance: $ref: ./examples/StorageAppliances_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided storage appliance.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. summary: Microsoft Azure Delete The Storage Appliance operationId: microsoftAzureStorageappliancesDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageApplianceNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete storage appliance: $ref: ./examples/StorageAppliances_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Update properties of the provided storage appliance, or update tags associated with the storage appliance Properties and tag updates can be done independently. summary: Microsoft Azure Patch The Storage Appliance operationId: microsoftAzureStorageappliancesUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageApplianceNameParameter' - description: The request body. name: storageApplianceUpdateParameters in: body schema: $ref: '#/definitions/StorageAppliancePatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/StorageAppliance' '202': description: Accepted schema: $ref: '#/definitions/StorageAppliance' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch storage appliance: $ref: ./examples/StorageAppliances_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/disableRemoteVendorManagement : post: description: Disable remote vendor management of the provided storage appliance. summary: Microsoft Azure Turn Off Remote Vendor Management For A Storage Appliance, If Supported operationId: microsoftAzureStorageappliancesDisableremotevendormanagement parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageApplianceNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Turn off remote vendor management for storage appliance: $ref: ./examples/StorageAppliances_DisableRemoteVendorManagement.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/enableRemoteVendorManagement : post: description: Enable remote vendor management of the provided storage appliance. summary: Microsoft Azure Turn On Remote Vendor Management For A Storage Appliance, If Supported operationId: microsoftAzureStorageappliancesEnableremotevendormanagement parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageApplianceNameParameter' - description: The request body. name: storageApplianceEnableRemoteVendorManagementParameters in: body schema: $ref: '#/definitions/StorageApplianceEnableRemoteVendorManagementParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Turn on remote vendor management for storage appliance: $ref: ./examples/StorageAppliances_EnableRemoteVendorManagement.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks: get: description: Get a list of trunked networks in the provided resource group. summary: Microsoft Azure List Trunked Networks In The Resource Group operationId: microsoftAzureTrunkednetworksListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/TrunkedNetworkList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List Trunked networks for resource group: $ref: ./examples/TrunkedNetworks_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks/{trunkedNetworkName} : get: description: Get properties of the provided trunked network. summary: Microsoft Azure Retrieve The Trunked Network operationId: microsoftAzureTrunkednetworksGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/TrunkedNetworkNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/TrunkedNetwork' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get Trunked network: $ref: ./examples/TrunkedNetworks_Get.json tags: - Subscriptions put: description: Create a new trunked network or update the properties of the existing trunked network. summary: Microsoft Azure Create Or Update The Trunked Network operationId: microsoftAzureTrunkednetworksCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/TrunkedNetworkNameParameter' - description: The request body. name: trunkedNetworkParameters in: body required: true schema: $ref: '#/definitions/TrunkedNetwork' responses: '200': description: OK schema: $ref: '#/definitions/TrunkedNetwork' '201': description: Created schema: $ref: '#/definitions/TrunkedNetwork' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update trunked network: $ref: ./examples/TrunkedNetworks_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided trunked network. summary: Microsoft Azure Delete The Trunked Network operationId: microsoftAzureTrunkednetworksDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/TrunkedNetworkNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete trunked network: $ref: ./examples/TrunkedNetworks_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Update tags associated with the provided trunked network. summary: Microsoft Azure Patch The Trunked Network operationId: microsoftAzureTrunkednetworksUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/TrunkedNetworkNameParameter' - description: The request body. name: trunkedNetworkUpdateParameters in: body schema: $ref: '#/definitions/TrunkedNetworkPatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/TrunkedNetwork' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch trunked network: $ref: ./examples/TrunkedNetworks_Patch.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines: get: description: Get a list of virtual machines in the provided resource group. summary: Microsoft Azure List Virtual Machines In The Resource Group operationId: microsoftAzureVirtualmachinesListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/VirtualMachineList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List virtual machines for resource group: $ref: ./examples/VirtualMachines_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName} : get: description: Get properties of the provided virtual machine. summary: Microsoft Azure Retrieve The Virtual Machine operationId: microsoftAzureVirtualmachinesGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/VirtualMachine' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get virtual machine: $ref: ./examples/VirtualMachines_Get.json tags: - Subscriptions put: description: Create a new virtual machine or update the properties of the existing virtual machine. summary: Microsoft Azure Create Or Update The Virtual Machine operationId: microsoftAzureVirtualmachinesCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' - description: The request body. name: virtualMachineParameters in: body required: true schema: $ref: '#/definitions/VirtualMachine' responses: '200': description: OK schema: $ref: '#/definitions/VirtualMachine' '201': description: Created schema: $ref: '#/definitions/VirtualMachine' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update virtual machine: $ref: ./examples/VirtualMachines_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided virtual machine. summary: Microsoft Azure Delete The Virtual Machine operationId: microsoftAzureVirtualmachinesDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete virtual machine: $ref: ./examples/VirtualMachines_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently. summary: Microsoft Azure Patch The Virtual Machine operationId: microsoftAzureVirtualmachinesUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' - description: The request body. name: virtualMachineUpdateParameters in: body schema: $ref: '#/definitions/VirtualMachinePatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/VirtualMachine' '202': description: Accepted schema: $ref: '#/definitions/VirtualMachine' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch virtual machine: $ref: ./examples/VirtualMachines_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles : get: description: Get a list of consoles for the provided virtual machine. summary: Microsoft Azure List Consoles Of The Virtual Machine operationId: microsoftAzureConsolesListbyvirtualmachine parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConsoleList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List consoles of the virtual machine: $ref: ./examples/Consoles_ListByVirtualMachine.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName} : get: description: Get properties of the provided virtual machine console. summary: Microsoft Azure Retrieve The Virtual Machine Console operationId: microsoftAzureConsolesGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' - $ref: '#/parameters/ConsoleNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/Console' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get virtual machine console: $ref: ./examples/Consoles_Get.json tags: - Subscriptions put: description: Create a new virtual machine console or update the properties of the existing virtual machine console. summary: Microsoft Azure Create Or Update The Virtual Machine Console operationId: microsoftAzureConsolesCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' - $ref: '#/parameters/ConsoleNameParameter' - description: The request body. name: consoleParameters in: body required: true schema: $ref: '#/definitions/Console' responses: '200': description: OK schema: $ref: '#/definitions/Console' '201': description: Created schema: $ref: '#/definitions/Console' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update virtual machine console: $ref: ./examples/Consoles_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided virtual machine console. summary: Microsoft Azure Delete The Virtual Machine Console operationId: microsoftAzureConsolesDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' - $ref: '#/parameters/ConsoleNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete virtual machine console: $ref: ./examples/Consoles_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Patch the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently. summary: Microsoft Azure Patch The Virtual Machine Console operationId: microsoftAzureConsolesUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' - $ref: '#/parameters/ConsoleNameParameter' - description: The request body. name: consoleUpdateParameters in: body schema: $ref: '#/definitions/ConsolePatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/Console' '202': description: Accepted schema: $ref: '#/definitions/Console' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch virtual machine console: $ref: ./examples/Consoles_Patch.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/powerOff : post: description: Power off the provided virtual machine. summary: Microsoft Azure Power Off The Virtual Machine operationId: microsoftAzureVirtualmachinesPoweroff parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' - description: The request body. name: virtualMachinePowerOffParameters in: body schema: $ref: '#/definitions/VirtualMachinePowerOffParameters' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Power off virtual machine: $ref: ./examples/VirtualMachines_PowerOff.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/reimage : post: description: Reimage the provided virtual machine. summary: Microsoft Azure Reimage The Virtual Machine operationId: microsoftAzureVirtualmachinesReimage parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Reimage virtual machine: $ref: ./examples/VirtualMachines_Reimage.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/restart : post: description: Restart the provided virtual machine. summary: Microsoft Azure Restart The Virtual Machine operationId: microsoftAzureVirtualmachinesRestart parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Restart virtual machine: $ref: ./examples/VirtualMachines_Restart.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/start : post: description: Start the provided virtual machine. summary: Microsoft Azure Start The Virtual Machine operationId: microsoftAzureVirtualmachinesStart parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VirtualMachineNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Start virtual machine: $ref: ./examples/VirtualMachines_Start.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes: get: description: Get a list of volumes in the provided resource group. summary: Microsoft Azure List Volumes In The Resource Group operationId: microsoftAzureVolumesListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/VolumeList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List volumes for resource group: $ref: ./examples/Volumes_ListByResourceGroup.json x-ms-pageable: nextLinkName: nextLink tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes/{volumeName}: get: description: Get properties of the provided volume. summary: Microsoft Azure Retrieve The Volume operationId: microsoftAzureVolumesGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VolumeNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/Volume_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Get volume: $ref: ./examples/Volumes_Get.json tags: - Subscriptions put: description: Create a new volume or update the properties of the existing one. summary: Microsoft Azure Create Or Update The Volume operationId: microsoftAzureVolumesCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VolumeNameParameter' - description: The request body. name: volumeParameters in: body required: true schema: $ref: '#/definitions/Volume_2' responses: '200': description: OK schema: $ref: '#/definitions/Volume_2' '201': description: Created schema: $ref: '#/definitions/Volume_2' headers: Azure-AsyncOperation: type: string description: The URL to retrieve the status of the asynchronous operation. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Create or update volume: $ref: ./examples/Volumes_Create.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation tags: - Subscriptions delete: description: Delete the provided volume. summary: Microsoft Azure Delete The Volume operationId: microsoftAzureVolumesDelete parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VolumeNameParameter' responses: '202': description: Accepted headers: Location: type: string description: The URL to retrieve the status of the asynchronous operation. '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Delete volume: $ref: ./examples/Volumes_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-schema: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult final-state-via: location tags: - Subscriptions patch: description: Update tags associated with the provided volume. summary: Microsoft Azure Patch The Volume operationId: microsoftAzureVolumesUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VolumeNameParameter' - description: The request body. name: volumeUpdateParameters in: body schema: $ref: '#/definitions/VolumePatchParameters' responses: '200': description: OK schema: $ref: '#/definitions/Volume_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Patch volume: $ref: ./examples/Volumes_Patch.json tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability: get: operationId: microsoftAzureCheckdnsnameavailability description: Checks whether a domain name in the cloudapp.net zone is available for use. parameters: - name: location in: path required: true type: string description: The location of the domain name - name: domainNameLabel in: query required: false type: string description: 'The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$.' - $ref: '#/parameters/ApiVersionParameter_12' - $ref: '#/parameters/SubscriptionIdParameter_13' responses: '200': description: '' schema: $ref: '#/definitions/DnsNameAvailabilityResult' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Locations Location Checkdnsnameavailability tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/perimeterAssociableResourceTypes: get: operationId: microsoftAzurePerimeterassociableresourcetypesList description: Gets the list of resources that are onboarded with NSP. These resources can be associated with a network security perimeter x-ms-pageable: nextLinkName: nextLink parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/LocationParameter_4' - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the list of resources that are onboarded with network security perimeter feature. schema: $ref: '#/definitions/PerimeterAssociableResourcesListResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: Check Dns Name Availability: $ref: ./examples/PerimeterAssociableResourcesList.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Locations Location Perimeterassociableresourcetypes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices/{resourceName} : patch: operationId: microsoftAzureEnergyservicesUpdate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - in: path name: resourceName description: The resource name. required: true type: string - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: body schema: $ref: '#/definitions/EnergyResourceUpdate' responses: '200': description: Updates the oep resource. schema: $ref: '#/definitions/EnergyService' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: OepResource_Update: $ref: ./examples/OepResource_Update.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Openenergyplatform Energyservices Resourcename description: Needs a more full description created. tags: - Subscriptions delete: description: Deletes oep resource operationId: microsoftAzureEnergyservicesDelete x-ms-long-running-operation: true parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - in: path name: resourceName description: The resource name. required: true type: string - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success '202': description: The OEP resource will be deleted asynchronously '204': description: Returned when the operation returns no content. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: OepResource_Delete: $ref: ./examples/OepResource_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Openenergyplatform Energyservices Resourcename tags: - Subscriptions /subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/listSupportInfo: post: operationId: microsoftAzurePaloaltonetworkscloudngfwListsupportinfo parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/SupportInfoModel' default: description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen: $ref: ./examples/PaloAltoNetworksCloudngfw_listSupportInfo_MaximumSet_Gen.json PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen: $ref: ./examples/PaloAltoNetworksCloudngfw_listSupportInfo_MinimumSet_Gen.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Paloaltonetworks Cloudngfw Listsupportinfo description: Needs a more full description created. tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults: post: operationId: microsoftAzurePolicyeventsListqueryresultsforsubscription description: Queries policy events for the resources under the subscription. parameters: - $ref: '#/parameters/policyEventsResourceParameter' - $ref: '#/parameters/subscriptionIdParameter_6' - $ref: '#/parameters/apiVersionParameter_6' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyEventsQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query at subscription scope: $ref: ./examples/PolicyEvents_QuerySubscriptionScope.json Query at subscription scope with next link: $ref: ./examples/PolicyEvents_QuerySubscriptionScopeNextLink.json Time range; sort, select and limit: $ref: ./examples/PolicyEvents_TimeRangeSortSelectTop.json Filter and group with aggregate: $ref: ./examples/PolicyEvents_FilterAndGroupByWithAggregate.json Filter and group without aggregate: $ref: ./examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json Filter and aggregate only: $ref: ./examples/PolicyEvents_FilterAndAggregateOnly.json Filter and multiple groups: $ref: ./examples/PolicyEvents_FilterAndMultipleGroups.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Policyinsights Policyevents Policyeventsresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults : post: operationId: microsoftAzurePolicyeventsListqueryresultsforresourcegroup description: Queries policy events for the resources under the resource group. parameters: - $ref: '#/parameters/policyEventsResourceParameter' - $ref: '#/parameters/subscriptionIdParameter_6' - $ref: '#/parameters/resourceGroupNameParameter_6' - $ref: '#/parameters/apiVersionParameter_6' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyEventsQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query at resource group scope: $ref: ./examples/PolicyEvents_QueryResourceGroupScope.json Query at resource group scope with next link: $ref: ./examples/PolicyEvents_QueryResourceGroupScopeNextLink.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Policyevents Policyeventsresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults : post: operationId: microsoftAzurePolicyeventsListqueryresultsforpolicysetdefinition description: Queries policy events for the subscription level policy set definition. parameters: - $ref: '#/parameters/policyEventsResourceParameter' - $ref: '#/parameters/subscriptionIdParameter_6' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policySetDefinitionNameParameter' - $ref: '#/parameters/apiVersionParameter_6' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyEventsQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query at subscription level policy set definition scope: $ref: ./examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScope.json Query at subscription level policy set definition scope with next link: $ref: ./examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policysetdefinitions Policysetdefinitionname Providers Microsoft Policyinsights Policyevents Policyeventsresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults : post: operationId: microsoftAzurePolicyeventsListqueryresultsforpolicydefinition description: Queries policy events for the subscription level policy definition. parameters: - $ref: '#/parameters/policyEventsResourceParameter' - $ref: '#/parameters/subscriptionIdParameter_6' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policyDefinitionNameParameter' - $ref: '#/parameters/apiVersionParameter_6' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyEventsQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query at subscription level policy definition scope: $ref: ./examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScope.json Query at subscription level policy definition scope with next link: $ref: ./examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policydefinitions Policydefinitionname Providers Microsoft Policyinsights Policyevents Policyeventsresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults : post: operationId: microsoftAzurePolicyeventsListqueryresultsforsubscriptionlevelpolicyassignment description: Queries policy events for the subscription level policy assignment. parameters: - $ref: '#/parameters/policyEventsResourceParameter' - $ref: '#/parameters/subscriptionIdParameter_6' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policyAssignmentNameParameter' - $ref: '#/parameters/apiVersionParameter_6' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyEventsQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query at subscription level policy assignment scope: $ref: ./examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScope.json Query at subscription level policy assignment scope with next link: $ref: ./examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policyassignments Policyassignmentname Providers Microsoft Policyinsights Policyevents Policyeventsresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults : post: operationId: microsoftAzurePolicyeventsListqueryresultsforresourcegrouplevelpolicyassignment description: Queries policy events for the resource group level policy assignment. parameters: - $ref: '#/parameters/policyEventsResourceParameter' - $ref: '#/parameters/subscriptionIdParameter_6' - $ref: '#/parameters/resourceGroupNameParameter_6' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policyAssignmentNameParameter' - $ref: '#/parameters/apiVersionParameter_6' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyEventsQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query at resource group level policy assignment scope: $ref: ./examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScope.json Query at resource group level policy assignment scope with next link: $ref: ./examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Authorizationnamespace Policyassignments Policyassignmentname Providers Microsoft Policyinsights Policyevents Policyeventsresource Queryresults tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults: post: operationId: microsoftAzurePolicystatesListqueryresultsforsubscription description: Queries policy states for the resources under the subscription. parameters: - $ref: '#/parameters/policyStatesResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query latest at subscription scope: $ref: ./examples/PolicyStates_QuerySubscriptionScope.json Query latest at subscription scope with next link: $ref: ./examples/PolicyStates_QuerySubscriptionScopeNextLink.json Time range; sort, select and limit: $ref: ./examples/PolicyStates_TimeRangeSortSelectTop.json Filter and group with aggregate: $ref: ./examples/PolicyStates_FilterAndGroupByWithAggregate.json Filter and group without aggregate: $ref: ./examples/PolicyStates_FilterAndGroupByWithoutAggregate.json Filter and aggregate only: $ref: ./examples/PolicyStates_FilterAndAggregateOnly.json Filter and multiple groups: $ref: ./examples/PolicyStates_FilterAndMultipleGroups.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Policyinsights Policystates Policystatesresource Queryresults tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize: post: operationId: microsoftAzurePolicystatesSummarizeforsubscription description: Summarizes policy states for the resources under the subscription. parameters: - $ref: '#/parameters/policyStatesSummaryResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' responses: '200': description: Summarize results. schema: $ref: '#/definitions/SummarizeResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-examples: Summarize at subscription scope: $ref: ./examples/PolicyStates_SummarizeSubscriptionScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Policyinsights Policystates Policystatessummaryresource Summarize tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults : post: operationId: microsoftAzurePolicystatesListqueryresultsforresourcegroup description: Queries policy states for the resources under the resource group. parameters: - $ref: '#/parameters/policyStatesResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/resourceGroupNameParameter_7' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query latest at resource group scope: $ref: ./examples/PolicyStates_QueryResourceGroupScope.json Query latest at resource group scope with next link: $ref: ./examples/PolicyStates_QueryResourceGroupScopeNextLink.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Policystates Policystatesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize : post: operationId: microsoftAzurePolicystatesSummarizeforresourcegroup description: Summarizes policy states for the resources under the resource group. parameters: - $ref: '#/parameters/policyStatesSummaryResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/resourceGroupNameParameter_7' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' responses: '200': description: Summarize results. schema: $ref: '#/definitions/SummarizeResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-examples: Summarize at resource group scope: $ref: ./examples/PolicyStates_SummarizeResourceGroupScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Policystates Policystatessummaryresource Summarize tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults : post: operationId: microsoftAzurePolicystatesListqueryresultsforpolicysetdefinition description: Queries policy states for the subscription level policy set definition. parameters: - $ref: '#/parameters/policyStatesResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policySetDefinitionNameParameter' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query latest at subscription level policy set definition scope: $ref: ./examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json Query latest at subscription level policy set definition scope with next link: $ref: ./examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policysetdefinitions Policysetdefinitionname Providers Microsoft Policyinsights Policystates Policystatesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize : post: operationId: microsoftAzurePolicystatesSummarizeforpolicysetdefinition description: Summarizes policy states for the subscription level policy set definition. parameters: - $ref: '#/parameters/policyStatesSummaryResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policySetDefinitionNameParameter' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' responses: '200': description: Summarize results. schema: $ref: '#/definitions/SummarizeResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-examples: Summarize at policy set definition scope: $ref: ./examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policysetdefinitions Policysetdefinitionname Providers Microsoft Policyinsights Policystates Policystatessummaryresource Summarize tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults : post: operationId: microsoftAzurePolicystatesListqueryresultsforpolicydefinition description: Queries policy states for the subscription level policy definition. parameters: - $ref: '#/parameters/policyStatesResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policyDefinitionNameParameter' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query latest at subscription level policy definition scope: $ref: ./examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json Query latest at subscription level policy definition scope with next link: $ref: ./examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policydefinitions Policydefinitionname Providers Microsoft Policyinsights Policystates Policystatesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize : post: operationId: microsoftAzurePolicystatesSummarizeforpolicydefinition description: Summarizes policy states for the subscription level policy definition. parameters: - $ref: '#/parameters/policyStatesSummaryResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policyDefinitionNameParameter' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' responses: '200': description: Summarize results. schema: $ref: '#/definitions/SummarizeResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-examples: Summarize at policy definition scope: $ref: ./examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policydefinitions Policydefinitionname Providers Microsoft Policyinsights Policystates Policystatessummaryresource Summarize tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults : post: operationId: microsoftAzurePolicystatesListqueryresultsforsubscriptionlevelpolicyassignment description: Queries policy states for the subscription level policy assignment. parameters: - $ref: '#/parameters/policyStatesResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policyAssignmentNameParameter' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query latest at subscription level policy assignment scope: $ref: ./examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json Query latest at subscription level policy assignment scope with next Link: $ref: ./examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policyassignments Policyassignmentname Providers Microsoft Policyinsights Policystates Policystatesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize : post: operationId: microsoftAzurePolicystatesSummarizeforsubscriptionlevelpolicyassignment description: Summarizes policy states for the subscription level policy assignment. parameters: - $ref: '#/parameters/policyStatesSummaryResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policyAssignmentNameParameter' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' responses: '200': description: Summarize results. schema: $ref: '#/definitions/SummarizeResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-examples: Summarize at policy assignment scope: $ref: ./examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Authorizationnamespace Policyassignments Policyassignmentname Providers Microsoft Policyinsights Policystates Policystatessummaryresource Summarize tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults : post: operationId: microsoftAzurePolicystatesListqueryresultsforresourcegrouplevelpolicyassignment description: Queries policy states for the resource group level policy assignment. parameters: - $ref: '#/parameters/policyStatesResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/resourceGroupNameParameter_7' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policyAssignmentNameParameter' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query latest at resource group level policy assignment scope: $ref: ./examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json Query latest at resource group level policy assignment scope with next link: $ref: ./examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Authorizationnamespace Policyassignments Policyassignmentname Providers Microsoft Policyinsights Policystates Policystatesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize : post: operationId: microsoftAzurePolicystatesSummarizeforresourcegrouplevelpolicyassignment description: Summarizes policy states for the resource group level policy assignment. parameters: - $ref: '#/parameters/policyStatesSummaryResourceParameter' - $ref: '#/parameters/subscriptionId_5' - $ref: '#/parameters/resourceGroupNameParameter_7' - $ref: '#/parameters/authorizationNamespaceParameter' - $ref: '#/parameters/policyAssignmentNameParameter' - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' responses: '200': description: Summarize results. schema: $ref: '#/definitions/SummarizeResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-examples: Summarize at policy assignment scope: $ref: ./examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Authorizationnamespace Policyassignments Policyassignmentname Providers Microsoft Policyinsights Policystates Policystatessummaryresource Summarize tags: - Subscriptions ? /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults : post: operationId: microsoftAzurePolicytrackedresourcesListqueryresultsforsubscription description: Queries policy tracked resources under the subscription. parameters: - $ref: '#/parameters/policyTrackedResourcesResourceParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/subscriptionIdParameter_7' - $ref: '#/parameters/apiVersionParameter_8' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyTrackedResourcesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Query at subscription scope: $ref: ./examples/PolicyTrackedResources_QuerySubscriptionScope.json Query at subscription scope using query parameters: $ref: ./examples/PolicyTrackedResources_QuerySubscriptionScopeWithFilterAndTop.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Policyinsights Policytrackedresources Policytrackedresourcesresource Queryresults tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults : post: operationId: microsoftAzurePolicytrackedresourcesListqueryresultsforresourcegroup description: Queries policy tracked resources under the resource group. parameters: - $ref: '#/parameters/resourceGroupNameParameter_8' - $ref: '#/parameters/policyTrackedResourcesResourceParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/subscriptionIdParameter_7' - $ref: '#/parameters/apiVersionParameter_8' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyTrackedResourcesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Query at resource group scope: $ref: ./examples/PolicyTrackedResources_QueryResourceGroupScope.json Query at resource group scope using query parameters: $ref: ./examples/PolicyTrackedResources_QueryResourceGroupScopeWithFilterAndTop.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Policytrackedresources Policytrackedresourcesresource Queryresults tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PowerBIDedicated/skus: get: description: Lists eligible SKUs for PowerBI Dedicated resource provider. x-ms-examples: List eligible SKUs for a new capacity: $ref: ./examples/listSKUsForNew.json operationId: microsoftAzureCapacitiesListskus parameters: - $ref: '#/parameters/ApiVersionParameter_13' - $ref: '#/parameters/SubscriptionIdParameter_14' responses: '200': description: OK schema: $ref: '#/definitions/SkuEnumerationForNewResourceResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_9' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Powerbidedicated Skus tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.RecommendationsService/checkNameAvailability: post: operationId: microsoftAzureAccountsChecknameavailability description: Checks that the RecommendationsService Account name is valid and is not already in use. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - description: Check name availability request details. name: body in: body required: true schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest responses: '200': description: Successful. The response describes the name availability. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Check name availability of RecommendationsService Account - name available: $ref: ./examples/Accounts_CheckNameAvailabilityAvailable.json Check name availability of RecommendationsService Account - name unavailable: $ref: ./examples/Accounts_CheckNameAvailabilityUnavailable.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Recommendationsservice Checknameavailability tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.RecommendationsService/accounts: get: operationId: microsoftAzureAccountsListbysubscription description: Returns list of RecommendationsService Account resources. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Account resources list. schema: $ref: '#/definitions/AccountResourceList_2' 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 RecommendationsService Account resources by subscription: $ref: ./examples/Accounts_ListBySubscription.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Recommendationsservice Accounts tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecommendationsService/accounts: get: operationId: microsoftAzureAccountsListbyresourcegroup description: Returns list of RecommendationsService Account resources. 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: Account resources list. schema: $ref: '#/definitions/AccountResourceList_2' 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 RecommendationsService Account resources by resource group: $ref: ./examples/Accounts_ListByResourceGroup.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecommendationsService/accounts/{accountName} : get: operationId: microsoftAzureAccountsGet description: Returns RecommendationsService Account resource for a given 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/AccountNameParameter_3' responses: '200': description: Account details. schema: $ref: '#/definitions/AccountResource_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Get RecommendationsService Account resource: $ref: ./examples/Accounts_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname tags: - Subscriptions put: operationId: microsoftAzureAccountsCreateorupdate description: Creates or updates RecommendationsService Account resource. 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/AccountNameParameter_3' - description: Account details. name: body in: body required: true schema: $ref: '#/definitions/AccountResource_2' responses: '200': description: Successful. schema: $ref: '#/definitions/AccountResource_2' '201': description: RecommendationsService Account resource is being created or updated. schema: $ref: '#/definitions/AccountResource_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Create or update RecommendationsService Account resource: $ref: ./examples/Accounts_CreateOrUpdate.json Create or update RecommendationsService Account resource with managed identity: $ref: ./examples/Accounts_CreateOrUpdateWithManagedIdentity.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname tags: - Subscriptions patch: operationId: microsoftAzureAccountsUpdate description: Updates RecommendationsService Account details. 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/AccountNameParameter_3' - description: Account resource patch details. name: body in: body required: true schema: $ref: '#/definitions/AccountPatchResource_2' responses: '200': description: Successful. schema: $ref: '#/definitions/AccountResource_2' '202': description: RecommendationsService Account resource is being updated. schema: $ref: '#/definitions/AccountResource_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Update existing RecommendationsService Account resource: $ref: ./examples/Accounts_Update.json Update existing RecommendationsService Account resource with managed identity: $ref: ./examples/Accounts_UpdateWithManagedIdentity.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname tags: - Subscriptions delete: operationId: microsoftAzureAccountsDelete description: Deletes RecommendationsService Account resource. 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/AccountNameParameter_3' responses: '200': description: RecommendationsService Account resource deleted successfully. '202': description: RecommendationsService Account resource is being deleted. '204': description: RecommendationsService Account resource does not exist. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Delete RecommendationsService Account resource: $ref: ./examples/Accounts_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecommendationsService/accounts/{accountName}/status : post: operationId: microsoftAzureAccountsGetstatus description: Returns RecommendationsService Account status. 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/AccountNameParameter_3' responses: '200': description: The status of the account. schema: $ref: '#/definitions/AccountStatus' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Get RecommendationsService Account status - Modeling resource exists: $ref: ./examples/Accounts_GetStatus_ModelingExists.json Get account status - no Modeling resource exists: $ref: ./examples/Accounts_GetStatus_NoModelingExists.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Status tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecommendationsService/accounts/{accountName}/modeling : get: operationId: microsoftAzureModelingListbyaccountresource description: Returns list of Modeling resources for a given Account 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/AccountNameParameter_3' responses: '200': description: Modeling resources list. schema: $ref: '#/definitions/ModelingResourceList' 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 Modeling resources by RecommendationsService Account resource: $ref: ./examples/Modeling_ListByAccountResource.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Modeling tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecommendationsService/accounts/{accountName}/modeling/{modelingName} : get: operationId: microsoftAzureModelingGet description: Returns Modeling resources for a given 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/AccountNameParameter_3' - $ref: '#/parameters/ModelingNameParameter' responses: '200': description: Modeling resource details. schema: $ref: '#/definitions/ModelingResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Get Modeling resource: $ref: ./examples/Modeling_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Modeling Modelingname tags: - Subscriptions put: operationId: microsoftAzureModelingCreateorupdate description: Creates or updates Modeling resource. 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/AccountNameParameter_3' - $ref: '#/parameters/ModelingNameParameter' - description: Modeling resource details. name: body in: body required: true schema: $ref: '#/definitions/ModelingResource' responses: '200': description: Successful. schema: $ref: '#/definitions/ModelingResource' '201': description: Modeling resource is being created or updated. schema: $ref: '#/definitions/ModelingResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Create or update Modeling resource: $ref: ./examples/Modeling_CreateOrUpdate.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Modeling Modelingname tags: - Subscriptions patch: operationId: microsoftAzureModelingUpdate description: Updates Modeling resource details. 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/AccountNameParameter_3' - $ref: '#/parameters/ModelingNameParameter' - description: Modeling resource patch details. name: body in: body required: true schema: $ref: '#/definitions/ModelingPatchResource' responses: '200': description: Successful. schema: $ref: '#/definitions/ModelingResource' '202': description: Modeling resource is being updated. schema: $ref: '#/definitions/ModelingResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Update Modeling resource: $ref: ./examples/Modeling_Update.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Modeling Modelingname tags: - Subscriptions delete: operationId: microsoftAzureModelingDelete description: Deletes Modeling resources of a given 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/AccountNameParameter_3' - $ref: '#/parameters/ModelingNameParameter' responses: '200': description: Modeling resource deleted successfully. '202': description: Modeling resource is being deleted. '204': description: Modeling resource does not exist. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Delete Modeling resource: $ref: ./examples/Modeling_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Modeling Modelingname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecommendationsService/accounts/{accountName}/serviceEndpoints : get: operationId: microsoftAzureServiceendpointsListbyaccountresource description: Returns list of ServiceEndpoint resources for a given Account 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/AccountNameParameter_3' responses: '200': description: ServiceEndpoint resources list. schema: $ref: '#/definitions/ServiceEndpointResourceList' 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 ServiceEndpoint resources by RecommendationsService Account resource: $ref: ./examples/ServiceEndpoints_ListByAccountResource.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Serviceendpoints tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecommendationsService/accounts/{accountName}/serviceEndpoints/{serviceEndpointName} : get: operationId: microsoftAzureServiceendpointsGet description: Returns ServiceEndpoint resources for a given 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/AccountNameParameter_3' - $ref: '#/parameters/ServiceEndpointNameParameter' responses: '200': description: ServiceEndpoint resource details. schema: $ref: '#/definitions/ServiceEndpointResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Get ServiceEndpoint resource: $ref: ./examples/ServiceEndpoints_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Serviceendpoints Serviceendpointname tags: - Subscriptions put: operationId: microsoftAzureServiceendpointsCreateorupdate description: Creates or updates ServiceEndpoint resource. 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/AccountNameParameter_3' - $ref: '#/parameters/ServiceEndpointNameParameter' - description: ServiceEndpoint resource details. name: body in: body required: true schema: $ref: '#/definitions/ServiceEndpointResource' responses: '200': description: Successful. schema: $ref: '#/definitions/ServiceEndpointResource' '201': description: ServiceEndpoint resource is being created or updated. schema: $ref: '#/definitions/ServiceEndpointResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Create or update ServiceEndpoint resource: $ref: ./examples/ServiceEndpoints_CreateOrUpdate.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Serviceendpoints Serviceendpointname tags: - Subscriptions patch: operationId: microsoftAzureServiceendpointsUpdate description: Updates ServiceEndpoint resource details. 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/AccountNameParameter_3' - $ref: '#/parameters/ServiceEndpointNameParameter' - description: ServiceEndpoint resource patch details. name: body in: body required: true schema: $ref: '#/definitions/ServiceEndpointPatchResource' responses: '200': description: Successful. schema: $ref: '#/definitions/ServiceEndpointResource' '202': description: ServiceEndpoint resource is being updated. schema: $ref: '#/definitions/ServiceEndpointResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Update ServiceEndpoint resource: $ref: ./examples/ServiceEndpoints_Update.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Serviceendpoints Serviceendpointname tags: - Subscriptions delete: operationId: microsoftAzureServiceendpointsDelete description: Deletes ServiceEndpoint resources of a given 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/AccountNameParameter_3' - $ref: '#/parameters/ServiceEndpointNameParameter' responses: '200': description: ServiceEndpoint resource deleted successfully. '202': description: ServiceEndpoint Account resource is being created or updated. '204': description: ServiceEndpoint resource does not exist. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Delete ServiceEndpoint resource: $ref: ./examples/ServiceEndpoints_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recommendationsservice Accounts Accountname Serviceendpoints Serviceendpointname tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments: post: operationId: microsoftAzureRemediationsListdeploymentsatsubscription description: Gets all deployments for a remediation at subscription scope. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediation deployments. schema: $ref: '#/definitions/RemediationDeploymentsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List deployments for a remediation at subscription scope: $ref: ./examples/Remediations_ListDeploymentsSubscriptionScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Policyinsights Remediations Remediationname Listdeployments tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel: post: operationId: microsoftAzureRemediationsCancelatsubscription description: Cancels a remediation at subscription scope. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The remediation that was canceled. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Cancel a remediation at subscription scope: $ref: ./examples/Remediations_CancelSubscriptionScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Policyinsights Remediations Remediationname Cancel tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations: get: operationId: microsoftAzureRemediationsListforsubscription description: Gets all remediations for the subscription. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediations. schema: $ref: '#/definitions/RemediationListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List remediations at subscription scope: $ref: ./examples/Remediations_ListSubscriptionScope.json List remediations at subscription scope with query parameters: $ref: ./examples/Remediations_ListSubscriptionScope_WithQuery.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Policyinsights Remediations tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}: put: operationId: microsoftAzureRemediationsCreateorupdateatsubscription description: Creates or updates a remediation at subscription scope. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' - name: parameters in: body required: true schema: $ref: '#/definitions/Remediation' description: The remediation parameters. responses: '200': description: The updated remediation. schema: $ref: '#/definitions/Remediation' '201': description: The created remediation. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Create remediation at subscription scope: $ref: ./examples/Remediations_CreateSubscriptionScope.json Create remediation at subscription scope with all properties: $ref: ./examples/Remediations_CreateSubscriptionScope_AllProperties.json summary: Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Policyinsights Remediations Remediationname tags: - Subscriptions get: operationId: microsoftAzureRemediationsGetatsubscription description: Gets an existing remediation at subscription scope. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediation. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get remediation at subscription scope: $ref: ./examples/Remediations_GetSubscriptionScope.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Policyinsights Remediations Remediationname tags: - Subscriptions delete: operationId: microsoftAzureRemediationsDeleteatsubscription description: Deletes an existing remediation at subscription scope. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The deleted remediation. schema: $ref: '#/definitions/Remediation' '204': description: The remediation did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Delete remediation at subscription scope: $ref: ./examples/Remediations_DeleteSubscriptionScope.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Providers Microsoft Policyinsights Remediations Remediationname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments : post: operationId: microsoftAzureRemediationsListdeploymentsatresourcegroup description: Gets all deployments for a remediation at resource group scope. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/resourceGroupNameParameter_10' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediation deployments. schema: $ref: '#/definitions/RemediationDeploymentsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List deployments for a remediation at resource group scope: $ref: ./examples/Remediations_ListDeploymentsResourceGroupScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Remediations Remediationname Listdeployments tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel : post: operationId: microsoftAzureRemediationsCancelatresourcegroup description: Cancels a remediation at resource group scope. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/resourceGroupNameParameter_10' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The remediation that was canceled. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Cancel a remediation at resource group scope: $ref: ./examples/Remediations_CancelResourceGroupScope.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Remediations Remediationname Cancel tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations: get: operationId: microsoftAzureRemediationsListforresourcegroup description: Gets all remediations for the subscription. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/resourceGroupNameParameter_10' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediations. schema: $ref: '#/definitions/RemediationListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List remediations at resource group scope: $ref: ./examples/Remediations_ListResourceGroupScope.json List remediations at resource group scope with query parameters: $ref: ./examples/Remediations_ListResourceGroupScope_WithQuery.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Remediations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName} : put: operationId: microsoftAzureRemediationsCreateorupdateatresourcegroup description: Creates or updates a remediation at resource group scope. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/resourceGroupNameParameter_10' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' - name: parameters in: body required: true schema: $ref: '#/definitions/Remediation' description: The remediation parameters. responses: '200': description: The updated remediation. schema: $ref: '#/definitions/Remediation' '201': description: The created remediation. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Create remediation at resource group scope: $ref: ./examples/Remediations_CreateResourceGroupScope.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Remediations Remediationname tags: - Subscriptions get: operationId: microsoftAzureRemediationsGetatresourcegroup description: Gets an existing remediation at resource group scope. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/resourceGroupNameParameter_10' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediation. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get remediation at resource group scope: $ref: ./examples/Remediations_GetResourceGroupScope.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Remediations Remediationname tags: - Subscriptions delete: operationId: microsoftAzureRemediationsDeleteatresourcegroup description: Deletes an existing remediation at resource group scope. parameters: - $ref: '#/parameters/subscriptionIdParameter_9' - $ref: '#/parameters/resourceGroupNameParameter_10' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The deleted remediation. schema: $ref: '#/definitions/Remediation' '204': description: The remediation did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Delete remediation at resource group scope: $ref: ./examples/Remediations_DeleteResourceGroupScope.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Policyinsights Remediations Remediationname tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Migrate/moveCollections: get: summary: Microsoft Azure Get All Move Collections description: Get all the Move Collections in the subscription. operationId: microsoftAzureMovecollectionsListmovecollectionsbysubscription produces: - application/json parameters: - $ref: '#/parameters/subscriptionId_6' - $ref: '#/parameters/api-version_2' responses: '200': description: OK. schema: $ref: '#/definitions/MoveCollectionResultList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_9' x-ms-pageable: nextLinkName: nextLink x-ms-examples: MoveCollections_ListMoveCollectionsBySubscription: $ref: ./examples/MoveCollections_ListMoveCollectionsBySubscription.json tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections: get: summary: Microsoft Azure Get All Move Collections description: Get all the Move Collections in the resource group. operationId: microsoftAzureMovecollectionsListmovecollectionsbyresourcegroup produces: - application/json parameters: - $ref: '#/parameters/subscriptionId_6' - $ref: '#/parameters/resourceGroupName_5' - $ref: '#/parameters/api-version_2' responses: '200': description: OK. schema: $ref: '#/definitions/MoveCollectionResultList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_9' x-ms-pageable: nextLinkName: nextLink x-ms-examples: MoveCollections_ListMoveCollectionsByResourceGroup: $ref: ./examples/MoveCollections_ListMoveCollectionsByResourceGroup.json tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/requiredFor : get: description: List of the move resources for which an arm resource is required for. operationId: microsoftAzureMovecollectionsListrequiredfor produces: - application/json parameters: - $ref: '#/parameters/subscriptionId_6' - $ref: '#/parameters/resourceGroupName_5' - $ref: '#/parameters/moveCollectionName' - name: sourceId in: query required: true type: string description: The sourceId for which the api is invoked. - $ref: '#/parameters/api-version_2' responses: '200': description: Success schema: $ref: '#/definitions/RequiredForResourcesCollection' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_9' x-ms-examples: RequiredFor_Get: $ref: ./examples/RequiredFor_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Movecollections Movecollectionname Requiredfor tags: - Subscriptions /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}: delete: tags: - Subscriptions operationId: microsoftAzureTagsDeletevalue summary: Microsoft Azure Deletes A Predefined Tag Value For A Predefined Tag Name description: This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource. parameters: - name: tagName in: path required: true type: string description: The name of the tag. - name: tagValue in: path required: true type: string description: The value of the tag to delete. - $ref: '#/parameters/ApiVersionParameter_14' - $ref: '#/parameters/SubscriptionIdParameter_15' responses: '200': description: Predefined tag value successfully deleted. '204': description: Predefined tag value did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_10' put: tags: - Subscriptions operationId: microsoftAzureTagsCreateorupdatevalue summary: Microsoft Azure Creates A Predefined Value For A Predefined Tag Name description: This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters. parameters: - name: tagName in: path required: true type: string description: The name of the tag. - name: tagValue in: path required: true type: string description: The value of the tag to create. - $ref: '#/parameters/ApiVersionParameter_14' - $ref: '#/parameters/SubscriptionIdParameter_15' responses: '200': description: Predefined tag value already exists. Returns information about the predefined tag value. schema: $ref: '#/definitions/TagValue' '201': description: Predefined tag value successfully created. Returns information about the predefined tag value. schema: $ref: '#/definitions/TagValue' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_10' /subscriptions/{subscriptionId}/tagNames/{tagName}: put: tags: - Subscriptions operationId: microsoftAzureTagsCreateorupdate summary: Microsoft Azure Creates A Predefined Tag Name description: 'This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: ''microsoft'', ''azure'', ''windows''.' parameters: - name: tagName in: path required: true type: string description: The name of the tag to create. - $ref: '#/parameters/ApiVersionParameter_14' - $ref: '#/parameters/SubscriptionIdParameter_15' responses: '200': description: Predefined tag name already exists. Returns information about the predefined tag name. schema: $ref: '#/definitions/TagDetails' '201': description: Predefined tag name successfully created. Returns information about the predefined tag name. schema: $ref: '#/definitions/TagDetails' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_10' delete: tags: - Subscriptions operationId: microsoftAzureTagsDelete summary: Microsoft Azure Deletes A Predefined Tag Name description: This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted. parameters: - name: tagName in: path required: true type: string description: The name of the tag. - $ref: '#/parameters/ApiVersionParameter_14' - $ref: '#/parameters/SubscriptionIdParameter_15' responses: '200': description: Predefined tag name successfully deleted. '204': description: Predefined tag name did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_10' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services : get: operationId: microsoftAzureServiceListbyapplicationname x-ms-examples: ServiceGetAll: $ref: ./examples/ServiceList.json summary: Microsoft Azure Gets Services Of A Given Application description: Gets the information about all services of a given service of an application. The information includes the runtime properties of the service instance. parameters: - $ref: '#/parameters/subscriptionIdRequiredPathParam' - $ref: '#/parameters/api-versionRequiredQueryParam' - $ref: '#/parameters/ResourceGroupNameRequiredPathParam' - $ref: '#/parameters/ApplicationNameRequiredPathParam' tags: - Subscriptions responses: '200': description: OK schema: $ref: '#/definitions/ServiceList' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName} : get: operationId: microsoftAzureServiceGet x-ms-examples: ServiceGet: $ref: ./examples/ServiceGet.json summary: Microsoft Azure Gets The Properties Of The Service description: The operation returns the properties of the service. parameters: - $ref: '#/parameters/subscriptionIdRequiredPathParam' - $ref: '#/parameters/api-versionRequiredQueryParam' - $ref: '#/parameters/ResourceGroupNameRequiredPathParam' - $ref: '#/parameters/ApplicationNameRequiredPathParam' - $ref: '#/parameters/ServiceNameRequiredPathParam' tags: - Subscriptions responses: '200': description: OK schema: $ref: '#/definitions/ServiceResourceDescription' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} : put: tags: - Subscriptions operationId: microsoftAzureServicesCreateorupdate x-ms-examples: SearchCreateOrUpdateService: $ref: ./examples/SearchCreateOrUpdateService.json SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs: $ref: ./examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass: $ref: ./examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass.json SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints: $ref: ./examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json SearchCreateOrUpdateServiceWithIdentity: $ref: ./examples/SearchCreateOrUpdateServiceWithIdentity.json SearchCreateOrUpdateServiceAuthOptions: $ref: ./examples/SearchCreateOrUpdateServiceAuthOptions.json SearchCreateOrUpdateServiceDisableLocalAuth: $ref: ./examples/SearchCreateOrUpdateServiceDisableLocalAuth.json SearchCreateOrUpdateServiceWithCmkEnforcement: $ref: ./examples/SearchCreateOrUpdateServiceWithCmkEnforcement.json SearchCreateOrUpdateServiceWithDataExfiltration: $ref: ./examples/SearchCreateOrUpdateServiceWithDataExfiltration.json SearchCreateOrUpdateWithSemanticSearch: $ref: ./examples/SearchCreateOrUpdateWithSemanticSearch.json description: Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter_5' - name: searchServiceName in: path required: true type: string description: The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created. - name: service in: body required: true schema: $ref: '#/definitions/SearchService' description: The definition of the search service to create or update. - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_15' - $ref: '#/parameters/SubscriptionIdParameter_16' responses: '200': description: The existing service definition was successfully updated. If you changed the number of replicas or partitions, the scale operation will happen asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property. schema: $ref: '#/definitions/SearchService' '201': description: If you requested creation of a free search service, the service is now provisioned and ready to use, subject to DNS propagation delay. For other SKU types, provisioning happens asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property. schema: $ref: '#/definitions/SearchService' default: description: 'HTTP 400 (Bad Request): The given service name or service definition is invalid; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription or resource group could not be found. HTTP 409 (Conflict): The specified subscription is disabled.' schema: $ref: '#/definitions/CloudError_11' x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename patch: tags: - Subscriptions operationId: microsoftAzureServicesUpdate x-ms-examples: SearchUpdateService: $ref: ./examples/SearchUpdateService.json SearchUpdateServiceToRemoveIdentity: $ref: ./examples/SearchUpdateServiceToRemoveIdentity.json SearchUpdateServiceToAllowAccessFromPublicCustomIPs: $ref: ./examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass: $ref: ./examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass.json SearchUpdateServiceToAllowAccessFromPrivateEndpoints: $ref: ./examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json SearchUpdateServiceAuthOptions: $ref: ./examples/SearchUpdateServiceAuthOptions.json SearchUpdateServiceDisableLocalAuth: $ref: ./examples/SearchUpdateServiceDisableLocalAuth.json SearchUpdateServiceWithCmkEnforcement: $ref: ./examples/SearchUpdateServiceWithCmkEnforcement.json SearchUpdateServiceWithDataExfiltration: $ref: ./examples/SearchUpdateServiceWithDataExfiltration.json SearchUpdateServiceWithSemanticSearch: $ref: ./examples/SearchUpdateServiceWithSemanticSearch.json description: Updates an existing search service in the given resource group. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter_5' - name: searchServiceName in: path required: true type: string description: The name of the Azure Cognitive Search service to update. - name: service in: body required: true schema: $ref: '#/definitions/SearchServiceUpdate' description: The definition of the search service to update. - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_15' - $ref: '#/parameters/SubscriptionIdParameter_16' responses: '200': description: The existing service definition was successfully updated. If you changed the number of replicas or partitions, the scale operation will happen asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property. schema: $ref: '#/definitions/SearchService' default: description: 'HTTP 400 (Bad Request): The given service definition is invalid or you attempted to change a property that is immutable; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription or resource group could not be found. HTTP 409 (Conflict): The specified subscription is disabled.' schema: $ref: '#/definitions/CloudError_11' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename get: tags: - Subscriptions operationId: microsoftAzureServicesGet x-ms-examples: SearchGetService: $ref: ./examples/SearchGetService.json description: Gets the search service with the given name in the given resource group. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter_5' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_15' - $ref: '#/parameters/SubscriptionIdParameter_16' responses: '200': description: The search service definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property. schema: $ref: '#/definitions/SearchService' default: description: 'HTTP 404 (Not Found): The subscription, resource group, or search service name could not be found.' schema: $ref: '#/definitions/CloudError_11' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename delete: tags: - Subscriptions operationId: microsoftAzureServicesDelete x-ms-examples: SearchDeleteService: $ref: ./examples/SearchDeleteService.json description: Deletes a search service in the given resource group, along with its associated resources. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter_5' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_15' - $ref: '#/parameters/SubscriptionIdParameter_16' responses: '200': description: The search service was successfully deleted. '204': description: The search service was successfully deleted. '404': description: The subscription, resource group, or search service could not be found. default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError_11' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices: get: tags: - Subscriptions x-ms-pageable: nextLinkName: nextLink operationId: microsoftAzureServicesListbyresourcegroup x-ms-examples: SearchListServicesByResourceGroup: $ref: ./examples/SearchListServicesByResourceGroup.json description: Gets a list of all Search services in the given resource group. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter_5' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_15' - $ref: '#/parameters/SubscriptionIdParameter_16' responses: '200': description: The operation succeeded. The response contains the list of all search service definitions for the given resource group. schema: $ref: '#/definitions/SearchServiceListResult' default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError_11' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices /subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices: get: tags: - Subscriptions x-ms-pageable: nextLinkName: nextLink operationId: microsoftAzureServicesListbysubscription x-ms-examples: SearchListServicesBySubscription: $ref: ./examples/SearchListServicesBySubscription.json description: Gets a list of all Search services in the given subscription. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_15' - $ref: '#/parameters/SubscriptionIdParameter_16' responses: '200': description: The operation succeeded. The response contains the list of all search service definitions for the given subscription. schema: $ref: '#/definitions/SearchServiceListResult' default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError_11' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Search Searchservices /subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability: post: tags: - Subscriptions description: Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). externalDocs: url: https://aka.ms/search-manage operationId: microsoftAzureServicesChecknameavailability x-ms-examples: SearchCheckNameAvailability: $ref: ./examples/SearchCheckNameAvailability.json parameters: - name: checkNameAvailabilityInput in: body description: The resource name and type to check. x-ms-client-flatten: true required: true schema: $ref: '#/definitions/CheckNameAvailabilityInput_2' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_15' - $ref: '#/parameters/SubscriptionIdParameter_16' responses: '200': description: The name check completed. The response contains details of whether the name is valid and available. If the name is invalid, the response also contains a message explaining why not. schema: $ref: '#/definitions/CheckNameAvailabilityOutput_2' default: description: 'HTTP 400 (Bad Request): The given resource type is not ''searchServices''.' schema: $ref: '#/definitions/CloudError_11' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Search Checknameavailability /subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/updateEncryption: post: x-ms-examples: Update the encryption settings.: $ref: ./examples/Subscriptions/UpdateEncryption.json description: Update the encryption settings. tags: - Subscriptions operationId: microsoftAzureSubscriptionsUpdateencryption parameters: - $ref: '#/parameters/SubscriptionIdParameter_18' - $ref: '#/parameters/ApiVersionParameter_17' responses: '200': description: OK default: description: Unexpected Error schema: $ref: Subscriptions.json#/definitions/Error summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Subscriptions Admin Updateencryption /subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/restoreData: post: x-ms-examples: Get the list of subscriptions.: $ref: ./examples/Subscriptions/List.json description: Restores the data tags: - Subscriptions operationId: microsoftAzureSubscriptionsRestoredata parameters: - $ref: '#/parameters/SubscriptionIdParameter_18' - $ref: '#/parameters/ApiVersionParameter_17' responses: '200': description: OK schema: $ref: '#/definitions/SubscriptionList_2' default: description: Unexpected Error schema: $ref: Subscriptions.json#/definitions/Error summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Subscriptions Admin Restoredata /subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/checkIdentityHealth: post: x-ms-examples: Check the identity health.: $ref: ./examples/Subscriptions/CheckIdentityHealth.json description: Checks the identity health tags: - Subscriptions operationId: microsoftAzureSubscriptionsCheckidentityhealth parameters: - $ref: '#/parameters/SubscriptionIdParameter_18' - $ref: '#/parameters/ApiVersionParameter_17' responses: '200': description: OK schema: $ref: '#/definitions/IdentityHealthCheckReportDefinition' default: description: Unexpected Error schema: $ref: Subscriptions.json#/definitions/Error summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Subscriptions Admin Checkidentityhealth /subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/moveSubscriptions: post: x-ms-examples: Move user subscriptions from the Default Provider to a Delegated Provider.: $ref: ./examples/Subscriptions/MoveSubscriptionsToDelegatedProvider.json Move user subscriptions from a Delegated Provider to the Default Provider.: $ref: ./examples/Subscriptions/MoveSubscriptionsToDefaultProvider.json description: Move subscriptions between delegated provider offers. tags: - Subscriptions operationId: microsoftAzureSubscriptionsMovesubscriptions parameters: - $ref: '#/parameters/SubscriptionIdParameter_18' - $ref: '#/parameters/ApiVersionParameter_17' - $ref: '#/parameters/MoveSubscriptionsParameter' responses: '202': description: Accepted -- Move subscriptions request accepted; operation will complete asynchronously. '204': description: No Content -- The subscriptions were successfully moved to the target delegated provider offer. default: description: Unexpected Error schema: $ref: Subscriptions.json#/definitions/Error x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Subscriptions Admin Movesubscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/validateMoveSubscriptions: post: x-ms-examples: Validate that user subscriptions can be moved from the Default Provider to a Delegated Provider.: $ref: ./examples/Subscriptions/ValidateMoveSubscriptionsToDelegatedProvider.json Validate that user subscriptions can be moved from a Delegated Provider to the Default Provider.: $ref: ./examples/Subscriptions/ValidateMoveSubscriptionsToDefaultProvider.json description: Validate that user subscriptions can be moved between delegated provider offers. tags: - Subscriptions operationId: microsoftAzureSubscriptionsValidatemovesubscriptions parameters: - $ref: '#/parameters/SubscriptionIdParameter_18' - $ref: '#/parameters/ApiVersionParameter_17' - $ref: '#/parameters/MoveSubscriptionsParameter' responses: '202': description: Accepted -- Validate move subscriptions request accepted; operation will complete asynchronously. '204': description: No Content -- The subscriptions can be moved to the target delegated provider offer. default: description: Unexpected Error schema: $ref: Subscriptions.json#/definitions/Error x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Subscriptions Admin Validatemovesubscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/subscriptions: get: x-ms-examples: Get the list of subscriptions.: $ref: ./examples/Subscriptions/List.json description: Get the list of subscriptions. tags: - Subscriptions operationId: microsoftAzureSubscriptionsList parameters: - $ref: '#/parameters/SubscriptionIdParameter_18' - $ref: '#/parameters/ApiVersionParameter_17' - $ref: '#/parameters/FilterParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/SubscriptionList_2' default: description: Unexpected Error schema: $ref: Subscriptions.json#/definitions/Error x-ms-pageable: nextLinkName: null x-ms-odata: '#/definitions/SubscriptionDefinition' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Subscriptions Admin Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/checkNameAvailability: post: x-ms-examples: Checks name availability in the Microsoft.Subscriptions.Admin namespace: $ref: ./examples/Subscriptions/CheckNameAvailability.json description: Get the list of subscriptions. tags: - Subscriptions operationId: microsoftAzureSubscriptionsChecknameavailability parameters: - $ref: '#/parameters/SubscriptionIdParameter_18' - $ref: '#/parameters/ApiVersionParameter_17' - $ref: '#/parameters/CheckNameAvailabilityParameter' responses: '200': description: OK schema: $ref: '#/definitions/CheckNameAvailabilityResponse' default: description: Unexpected Error schema: $ref: Subscriptions.json#/definitions/Error summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Subscriptions Admin Checknameavailability /subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/subscriptions/{targetSubscriptionId}: get: x-ms-examples: Get a specified subscription.: $ref: ./examples/Subscriptions/Get.json description: Get a specified subscription. tags: - Subscriptions operationId: microsoftAzureSubscriptionsGet parameters: - $ref: '#/parameters/SubscriptionIdParameter_18' - $ref: '#/parameters/TargetSubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter_17' responses: '200': description: OK schema: $ref: '#/definitions/SubscriptionDefinition' default: description: Unexpected Error schema: $ref: Subscriptions.json#/definitions/Error summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Subscriptions Admin Subscriptions Targetsubscriptionid put: x-ms-examples: Creates or updates the specified subscription.: $ref: ./examples/Subscriptions/Create.json description: Creates or updates the specified subscription. tags: - Subscriptions operationId: microsoftAzureSubscriptionsCreateorupdate parameters: - $ref: '#/parameters/SubscriptionIdParameter_18' - $ref: '#/parameters/TargetSubscriptionIdParameter' - $ref: '#/parameters/SubscriptionDefinitionParameter_2' - $ref: '#/parameters/ApiVersionParameter_17' responses: '200': description: OK schema: $ref: '#/definitions/SubscriptionDefinition' '201': description: Created schema: $ref: '#/definitions/SubscriptionDefinition' default: description: Unexpected Error schema: $ref: Subscriptions.json#/definitions/Error summary: Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Subscriptions Admin Subscriptions Targetsubscriptionid delete: x-ms-examples: Delete the specified subscription.: $ref: ./examples/Subscriptions/Delete.json description: Delete the specified subscription. tags: - Subscriptions operationId: microsoftAzureSubscriptionsDelete parameters: - $ref: '#/parameters/SubscriptionIdParameter_18' - $ref: '#/parameters/TargetSubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter_17' responses: '200': description: OK '204': description: No Content default: description: Unexpected Error schema: $ref: Subscriptions.json#/definitions/Error summary: Microsoft Azure Delete Subscriptions Subscriptionid Providers Microsoft Subscriptions Admin Subscriptions Targetsubscriptionid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/managedIdentitySqlControlSettings/default : get: operationId: microsoftAzureWorkspacemanagedidentitysqlcontrolsettingsGet summary: Microsoft Azure Get Managed Identity Sql Control Settings 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_2' responses: '200': schema: $ref: '#/definitions/ManagedIdentitySqlControlSettingsModel' description: OK default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: Error produces: - application/json x-ms-examples: Get managed identity sql control settings: $ref: ./examples/GetManagedIdentitySqlControlSettings.json description: Needs a more full description created. tags: - Subscriptions put: operationId: microsoftAzureWorkspacemanagedidentitysqlcontrolsettingsCreateorupdate summary: Microsoft Azure Create Or Update Managed Identity Sql Control Settings 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: ./workspace.json#/parameters/workspaceNameParameter - description: Managed Identity Sql Control Settings schema: $ref: '#/definitions/ManagedIdentitySqlControlSettingsModel' in: body name: managedIdentitySqlControlSettings required: true responses: '200': schema: $ref: '#/definitions/ManagedIdentitySqlControlSettingsModel' description: OK '201': description: Created default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: Error produces: - application/json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: Create or update managed identity sql control settings: $ref: ./examples/CreateOrUpdateManagedIdentitySqlControlSettings.json description: Needs a more full description created. tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Syntex/documentProcessors: get: description: Returns document processors in the subscription. operationId: microsoftAzureDocumentprocessorList parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Document processor details. schema: $ref: '#/definitions/DocumentProcessorList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: DocumentProcessor_List: $ref: ./examples/DocumentProcessor_List.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Syntex Documentprocessors tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Syntex/documentProcessors: get: description: Returns document processors in a resource group. operationId: microsoftAzureDocumentprocessorListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Document processor details. schema: $ref: '#/definitions/DocumentProcessorList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: DocumentProcessor_ListByResourceGroup: $ref: ./examples/DocumentProcessor_ListByResourceGroup.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Syntex Documentprocessors tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Syntex/documentProcessors/{processorName} : get: description: Returns a document processor for a given name. operationId: microsoftAzureDocumentprocessorGet parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ProcessorNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Document processor details. schema: $ref: '#/definitions/DocumentProcessorResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DocumentProcessor_Get: $ref: ./examples/DocumentProcessor_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Syntex Documentprocessors Processorname tags: - Subscriptions delete: description: Deletes document processor resource for a given name. operationId: microsoftAzureDocumentprocessorDelete parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ProcessorNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Deletes the document processor details. '204': description: The document processor details are not present. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DocumentProcessor_Delete: $ref: ./examples/DocumentProcessor_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Syntex Documentprocessors Processorname tags: - Subscriptions put: description: Creates a document processor resource for a given name. operationId: microsoftAzureDocumentprocessorCreate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ProcessorNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: body description: Document processor details. in: body required: true schema: $ref: '#/definitions/DocumentProcessorResource' responses: '200': description: Success schema: $ref: '#/definitions/DocumentProcessorResource' '201': description: Success schema: $ref: '#/definitions/DocumentProcessorResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DocumentProcessor_Create: $ref: ./examples/DocumentProcessor_Create.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Syntex Documentprocessors Processorname tags: - Subscriptions patch: description: Updates a document processor resource for a given name. operationId: microsoftAzureDocumentprocessorUpdate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ProcessorNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: body description: Document processor details. in: body required: true schema: $ref: '#/definitions/DocumentProcessorPatchableProperties' responses: '200': description: Success schema: $ref: '#/definitions/DocumentProcessorResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DocumentProcessor_Update: $ref: ./examples/DocumentProcessor_Update.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Syntex Documentprocessors Processorname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName} : get: operationId: microsoftAzureVirtualwansGet x-ms-examples: VirtualWANGet: $ref: ./examples/VirtualWANGet.json description: Retrieves the details of a VirtualWAN. parameters: - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualWan. - name: VirtualWANName in: path required: true type: string description: The name of the VirtualWAN being retrieved. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: Request successful. Returns the details of the VirtualWAN retrieved. schema: $ref: '#/definitions/VirtualWAN' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname tags: - Subscriptions put: operationId: microsoftAzureVirtualwansCreateorupdate x-ms-examples: VirtualWANCreate: $ref: ./examples/VirtualWANPut.json description: Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualWan. - name: VirtualWANName in: path required: true type: string description: The name of the VirtualWAN being created or updated. - $ref: ./network.json#/parameters/ApiVersionParameter - name: WANParameters in: body required: true schema: $ref: '#/definitions/VirtualWAN' description: Parameters supplied to create or update VirtualWAN. responses: '200': description: Request successful. Returns the details of the VirtualWAN created or updated. schema: $ref: '#/definitions/VirtualWAN' '201': description: Create successful. The operation returns the resulting VirtualWAN resource. schema: $ref: '#/definitions/VirtualWAN' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname tags: - Subscriptions delete: operationId: microsoftAzureVirtualwansDelete x-ms-examples: VirtualWANDelete: $ref: ./examples/VirtualWANDelete.json description: Deletes a VirtualWAN. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualWan. - name: VirtualWANName in: path required: true type: string description: The name of the VirtualWAN being deleted. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VirtualWAN deleted. '202': description: Request received successfully. VirtualWAN deletion is in progress; follow the Location header to poll for final outcome. '204': description: No VirtualWANs exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans: get: operationId: microsoftAzureVirtualwansListbyresourcegroup x-ms-examples: VirtualWANListByResourceGroup: $ref: ./examples/VirtualWANListByResourceGroup.json description: Lists all the VirtualWANs in a resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualWan. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VirtualWANs in the resource group. schema: $ref: '#/definitions/ListVirtualWANsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans: get: operationId: microsoftAzureVirtualwansList x-ms-examples: VirtualWANList: $ref: ./examples/VirtualWANList.json description: Lists all the VirtualWANs in a subscription. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VirtualWANs in the subscription. schema: $ref: '#/definitions/ListVirtualWANsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Virtualwans tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}: get: operationId: microsoftAzureVpnsitesGet x-ms-examples: VpnSiteGet: $ref: ./examples/VpnSiteGet.json description: Retrieves the details of a VPN site. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnSite. - name: vpnSiteName in: path required: true type: string description: The name of the VpnSite being retrieved. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the VpnSite retrieved. schema: $ref: '#/definitions/VpnSite' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename tags: - Subscriptions put: operationId: microsoftAzureVpnsitesCreateorupdate x-ms-examples: VpnSiteCreate: $ref: ./examples/VpnSitePut.json description: Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnSite. - name: vpnSiteName in: path required: true type: string description: The name of the VpnSite being created or updated. - $ref: ./network.json#/parameters/ApiVersionParameter - name: VpnSiteParameters in: body required: true schema: $ref: '#/definitions/VpnSite' description: Parameters supplied to create or update VpnSite. responses: '200': description: Request successful. Returns the details of the VpnSite created or updated. schema: $ref: '#/definitions/VpnSite' '201': description: Request received successfully. Returns the details of the VpnSite created or updated. schema: $ref: '#/definitions/VpnSite' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename tags: - Subscriptions delete: operationId: microsoftAzureVpnsitesDelete x-ms-examples: VpnSiteDelete: $ref: ./examples/VpnSiteDelete.json description: Deletes a VpnSite. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnSite. - name: vpnSiteName in: path required: true type: string description: The name of the VpnSite being deleted. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VpnSite deleted. '202': description: Request received successfully. VpnSite deletion is in progress. '204': description: No VpnSites exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites: get: operationId: microsoftAzureVpnsitesListbyresourcegroup x-ms-examples: VpnSiteListByResourceGroup: $ref: ./examples/VpnSiteListByResourceGroup.json description: Lists all the vpnSites in a resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnSite. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the vpnSites in the resource group. schema: $ref: '#/definitions/ListVpnSitesResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName} : get: operationId: microsoftAzureVpnsitelinksGet x-ms-examples: VpnSiteGet: $ref: ./examples/VpnSiteLinkGet.json description: Retrieves the details of a VPN site link. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnSite. - name: vpnSiteName in: path required: true type: string description: The name of the VpnSite. - name: vpnSiteLinkName in: path required: true type: string description: The name of the VpnSiteLink being retrieved. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the VpnSiteLink retrieved. schema: $ref: '#/definitions/VpnSiteLink' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename Vpnsitelinks Vpnsitelinkname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks : get: operationId: microsoftAzureVpnsitelinksListbyvpnsite x-ms-examples: VpnSiteLinkListByVpnSite: $ref: ./examples/VpnSiteLinkListByVpnSite.json description: Lists all the vpnSiteLinks in a resource group for a vpn site. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnSite. - name: vpnSiteName in: path required: true type: string description: The name of the VpnSite. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the vpnSites in the resource group. schema: $ref: '#/definitions/ListVpnSiteLinksResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename Vpnsitelinks tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites: get: operationId: microsoftAzureVpnsitesList x-ms-examples: VpnSiteList: $ref: ./examples/VpnSiteList.json description: Lists all the VpnSites in a subscription. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VpnSites in the subscription. schema: $ref: '#/definitions/ListVpnSitesResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Vpnsites tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration : post: operationId: microsoftAzureVpnsitesconfigurationDownload x-ms-examples: VpnSitesConfigurationDownload: $ref: ./examples/VpnSitesConfigurationDownload.json description: Gives the sas-url to download the configurations for vpn-sites in a resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: virtualWANName in: path required: true type: string description: The name of the VirtualWAN for which configuration of all vpn-sites is needed. - name: request in: body required: true schema: $ref: '#/definitions/GetVpnSitesConfigurationRequest' description: Parameters supplied to download vpn-sites configuration. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Follow the location header for sas-url to output blob. '202': description: Accepted and the operation will complete asynchronously. Follow the location header for sas-url to output blob. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname Vpnconfiguration tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders : get: operationId: microsoftAzureSupportedsecurityproviders x-ms-examples: supportedSecurityProviders: $ref: ./examples/VirtualWanSupportedSecurityProviders.json description: Gives the supported security providers for the virtual wan. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: virtualWANName in: path required: true type: string description: The name of the VirtualWAN for which supported security providers are needed. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the object containing supported security providers. schema: $ref: '#/definitions/VirtualWanSecurityProviders' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname Supportedsecurityproviders tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName} : get: operationId: microsoftAzureVpnserverconfigurationsGet x-ms-examples: VpnServerConfigurationGet: $ref: ./examples/VpnServerConfigurationGet.json description: Retrieves the details of a VpnServerConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration being retrieved. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the VpnServerConfiguration retrieved. schema: $ref: '#/definitions/VpnServerConfiguration' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname tags: - Subscriptions put: operationId: microsoftAzureVpnserverconfigurationsCreateorupdate x-ms-examples: VpnServerConfigurationCreate: $ref: ./examples/VpnServerConfigurationPut.json description: Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration being created or updated. - $ref: ./network.json#/parameters/ApiVersionParameter - name: VpnServerConfigurationParameters in: body required: true schema: $ref: '#/definitions/VpnServerConfiguration' description: Parameters supplied to create or update VpnServerConfiguration. responses: '200': description: Request successful. Returns the details of the VpnServerConfiguration created or updated. schema: $ref: '#/definitions/VpnServerConfiguration' '201': description: Request received successfully. Returns the details of the VpnServerConfiguration created or updated. schema: $ref: '#/definitions/VpnServerConfiguration' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname tags: - Subscriptions delete: operationId: microsoftAzureVpnserverconfigurationsDelete x-ms-examples: VpnServerConfigurationDelete: $ref: ./examples/VpnServerConfigurationDelete.json description: Deletes a VpnServerConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration being deleted. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VpnServerConfiguration deleted. '202': description: Request received successfully. VpnServerConfiguration deletion is in progress. '204': description: No VpnServerConfigurations exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations: get: operationId: microsoftAzureVpnserverconfigurationsListbyresourcegroup x-ms-examples: VpnServerConfigurationListByResourceGroup: $ref: ./examples/VpnServerConfigurationListByResourceGroup.json description: Lists all the vpnServerConfigurations in a resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the vpnServerConfigurations in the resource group. schema: $ref: '#/definitions/ListVpnServerConfigurationsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName} : put: operationId: microsoftAzureConfigurationpolicygroupsCreateorupdate x-ms-examples: ConfigurationPolicyGroupPut: $ref: ./examples/ConfigurationPolicyGroupPut.json description: Creates a ConfigurationPolicyGroup if it doesn't exist else updates the existing one. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the ConfigurationPolicyGroup. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration. - name: configurationPolicyGroupName in: path required: true type: string description: The name of the ConfigurationPolicyGroup. - $ref: ./network.json#/parameters/ApiVersionParameter - name: VpnServerConfigurationPolicyGroupParameters in: body required: true schema: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' description: Parameters supplied to create or update a VpnServerConfiguration PolicyGroup. responses: '200': description: Request successful. Returns the details of the VpnServerConfiguration PolicyGroup created or updated. schema: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' '201': description: Request successful. Returns the details of the VpnServerConfiguration PolicyGroup retrieved. schema: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname Configurationpolicygroups Configurationpolicygroupname tags: - Subscriptions delete: operationId: microsoftAzureConfigurationpolicygroupsDelete x-ms-examples: ConfigurationPolicyGroupDelete: $ref: ./examples/ConfigurationPolicyGroupDelete.json description: Deletes a ConfigurationPolicyGroup. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the ConfigurationPolicyGroup. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration. - name: configurationPolicyGroupName in: path required: true type: string description: The name of the ConfigurationPolicyGroup. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. ConfigurationPolicyGroup deleted. '202': description: Request received successfully. ConfigurationPolicyGroup deletion is in progress; follow the Location header to poll for final outcome. '204': description: No ConfigurationPolicyGroup exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname Configurationpolicygroups Configurationpolicygroupname tags: - Subscriptions get: operationId: microsoftAzureConfigurationpolicygroupsGet x-ms-examples: ConfigurationPolicyGroupGet: $ref: ./examples/ConfigurationPolicyGroupGet.json description: Retrieves the details of a ConfigurationPolicyGroup. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration. - name: configurationPolicyGroupName in: path required: true type: string description: The name of the ConfigurationPolicyGroup being retrieved. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the ConfigurationPolicyGroup retrieved. schema: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname Configurationpolicygroups Configurationpolicygroupname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups : get: operationId: microsoftAzureConfigurationpolicygroupsListbyvpnserverconfiguration x-ms-examples: ConfigurationPolicyGroupListByVpnServerConfiguration: $ref: ./examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json description: Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VpnServerConfigurations in the resource group. schema: $ref: '#/definitions/ListVpnServerConfigurationPolicyGroupsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname Configurationpolicygroups tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnServerConfigurations: get: operationId: microsoftAzureVpnserverconfigurationsList x-ms-examples: VpnServerConfigurationList: $ref: ./examples/VpnServerConfigurationList.json description: Lists all the VpnServerConfigurations in a subscription. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VpnServerConfigurations in the subscription. schema: $ref: '#/definitions/ListVpnServerConfigurationsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Vpnserverconfigurations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName} : get: operationId: microsoftAzureVirtualhubsGet x-ms-examples: VirtualHubGet: $ref: ./examples/VirtualHubGet.json description: Retrieves the details of a VirtualHub. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the VirtualHub retrieved. schema: $ref: '#/definitions/VirtualHub' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname tags: - Subscriptions put: operationId: microsoftAzureVirtualhubsCreateorupdate x-ms-examples: VirtualHubPut: $ref: ./examples/VirtualHubPut.json description: Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter - name: virtualHubParameters in: body required: true schema: $ref: '#/definitions/VirtualHub' description: Parameters supplied to create or update VirtualHub. responses: '200': description: Request successful. Returns the details of the VirtualHub created or updated. schema: $ref: '#/definitions/VirtualHub' '201': description: Request received successfully. Returns the details of the VirtualHub created or updated. schema: $ref: '#/definitions/VirtualHub' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname tags: - Subscriptions delete: operationId: microsoftAzureVirtualhubsDelete x-ms-examples: VirtualHubDelete: $ref: ./examples/VirtualHubDelete.json description: Deletes a VirtualHub. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VirtualHub deleted. '202': description: Request received successfully. VirtualHub deletion is in progress; follow the Location header to poll for final outcome. '204': description: No VirtualHubs exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs: get: operationId: microsoftAzureVirtualhubsListbyresourcegroup x-ms-examples: VirtualHubListByResourceGroup: $ref: ./examples/VirtualHubListByResourceGroup.json description: Lists all the VirtualHubs in a resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VirtualHubs in the resource group. schema: $ref: '#/definitions/ListVirtualHubsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs: get: operationId: microsoftAzureVirtualhubsList x-ms-examples: VirtualHubList: $ref: ./examples/VirtualHubList.json description: Lists all the VirtualHubs in a subscription. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VirtualHubs in the subscription. schema: $ref: '#/definitions/ListVirtualHubsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Virtualhubs tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName} : get: operationId: microsoftAzureRoutemapsGet x-ms-examples: RouteMapGet: $ref: ./examples/RouteMapGet.json description: Retrieves the details of a RouteMap. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RouteMap's resource group. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub containing the RouteMap. - name: routeMapName in: path required: true type: string description: The name of the RouteMap. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the RouteMap retrieved. schema: $ref: '#/definitions/RouteMap' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routemaps Routemapname tags: - Subscriptions put: operationId: microsoftAzureRoutemapsCreateorupdate x-ms-examples: RouteMapPut: $ref: ./examples/RouteMapPut.json description: Creates a RouteMap if it doesn't exist else updates the existing one. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RouteMap's resource group. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub containing the RouteMap. - name: routeMapName in: path required: true type: string description: The name of the RouteMap. - $ref: ./network.json#/parameters/ApiVersionParameter - name: routeMapParameters in: body required: true schema: $ref: '#/definitions/RouteMap' description: Parameters supplied to create or update a RouteMap. responses: '200': description: Request successful. Returns the details of the RouteMap created or updated. schema: $ref: '#/definitions/RouteMap' '201': description: Request successful. Returns the details of the RouteMap retrieved. schema: $ref: '#/definitions/RouteMap' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routemaps Routemapname tags: - Subscriptions delete: operationId: microsoftAzureRoutemapsDelete x-ms-examples: RouteMapDelete: $ref: ./examples/RouteMapDelete.json description: Deletes a RouteMap. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RouteMap's resource group. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub containing the RouteMap. - name: routeMapName in: path required: true type: string description: The name of the RouteMap. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. RouteMap deleted. '202': description: Request received successfully. RouteMap deletion is in progress; follow the Location header to poll for final outcome. '204': description: No RouteMaps exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routemaps Routemapname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps : get: operationId: microsoftAzureRoutemapsList x-ms-examples: RouteMapList: $ref: ./examples/RouteMapList.json description: Retrieves the details of all RouteMaps. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RouteMap's resource group'. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub containing the RouteMap. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the RouteMaps for the VirtualHub. schema: $ref: '#/definitions/ListRouteMapsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routemaps tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName} : put: operationId: microsoftAzureHubvirtualnetworkconnectionsCreateorupdate x-ms-examples: HubVirtualNetworkConnectionPut: $ref: ./examples/HubVirtualNetworkConnectionPut.json description: Creates a hub virtual network connection if it doesn't exist else updates the existing one. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the HubVirtualNetworkConnection. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: connectionName in: path required: true type: string description: The name of the HubVirtualNetworkConnection. - $ref: ./network.json#/parameters/ApiVersionParameter - name: hubVirtualNetworkConnectionParameters in: body required: true schema: $ref: '#/definitions/HubVirtualNetworkConnection' description: Parameters supplied to create or update a hub virtual network connection. responses: '200': description: Request successful. Returns the details of the hub virtual network connection created or updated. schema: $ref: '#/definitions/HubVirtualNetworkConnection' '201': description: Request successful. Returns the details of the hub virtual network connection retrieved. schema: $ref: '#/definitions/HubVirtualNetworkConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubvirtualnetworkconnections Connectionname tags: - Subscriptions delete: operationId: microsoftAzureHubvirtualnetworkconnectionsDelete x-ms-examples: HubVirtualNetworkConnectionDelete: $ref: ./examples/HubVirtualNetworkConnectionDelete.json description: Deletes a HubVirtualNetworkConnection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: connectionName in: path required: true type: string description: The name of the HubVirtualNetworkConnection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. HubVirtualNetworkConnection deleted. '202': description: Request received successfully. HubVirtualNetworkConnection deletion is in progress; follow the Location header to poll for final outcome. '204': description: No HubVirtualNetworkConnection exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubvirtualnetworkconnections Connectionname tags: - Subscriptions get: operationId: microsoftAzureHubvirtualnetworkconnectionsGet x-ms-examples: HubVirtualNetworkConnectionGet: $ref: ./examples/HubVirtualNetworkConnectionGet.json description: Retrieves the details of a HubVirtualNetworkConnection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: connectionName in: path required: true type: string description: The name of the vpn connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the HubVirtualNetworkConnection retrieved. schema: $ref: '#/definitions/HubVirtualNetworkConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubvirtualnetworkconnections Connectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections : get: operationId: microsoftAzureHubvirtualnetworkconnectionsList x-ms-examples: HubVirtualNetworkConnectionList: $ref: ./examples/HubVirtualNetworkConnectionList.json description: Retrieves the details of all HubVirtualNetworkConnections. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the HubVirtualNetworkConnections for the VirtualHub. schema: $ref: '#/definitions/ListHubVirtualNetworkConnectionsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubvirtualnetworkconnections tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}: get: operationId: microsoftAzureVpngatewaysGet x-ms-examples: VpnGatewayGet: $ref: ./examples/VpnGatewayGet.json description: Retrieves the details of a virtual wan vpn gateway. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the virtual wan vpn gateway retrieved. schema: $ref: '#/definitions/VpnGateway' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname tags: - Subscriptions put: operationId: microsoftAzureVpngatewaysCreateorupdate x-ms-examples: VpnGatewayPut: $ref: ./examples/VpnGatewayPut.json description: Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - $ref: ./network.json#/parameters/ApiVersionParameter - name: vpnGatewayParameters in: body required: true schema: $ref: '#/definitions/VpnGateway' description: Parameters supplied to create or Update a virtual wan vpn gateway. responses: '200': description: Request successful. Returns the details of the virtual wan vpn Gateway created or updated. schema: $ref: '#/definitions/VpnGateway' '201': description: Request successful. Returns the details of the virtual wan vpn gateway retrieved. schema: $ref: '#/definitions/VpnGateway' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname tags: - Subscriptions delete: operationId: microsoftAzureVpngatewaysDelete x-ms-examples: VpnGatewayDelete: $ref: ./examples/VpnGatewayDelete.json description: Deletes a virtual wan vpn gateway. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Vpn Gateway deleted. '202': description: Request received successfully. Vpn Gateway deletion is in progress; follow the Location header to poll for final outcome. '204': description: No vpn gateways exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways: get: operationId: microsoftAzureVpngatewaysListbyresourcegroup x-ms-examples: VpnGatewayListByResourceGroup: $ref: ./examples/VpnGatewayListByResourceGroup.json description: Lists all the VpnGateways in a resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VpnGateways in the resource group. schema: $ref: '#/definitions/ListVpnGatewaysResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways: get: operationId: microsoftAzureVpngatewaysList x-ms-examples: VpnGatewayListBySubscription: $ref: ./examples/VpnGatewayList.json description: Lists all the VpnGateways in a subscription. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VpnGateways in the subscription. schema: $ref: '#/definitions/ListVpnGatewaysResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Vpngateways tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName} : get: operationId: microsoftAzureVpnconnectionsGet x-ms-examples: VpnConnectionGet: $ref: ./examples/VpnConnectionGet.json description: Retrieves the details of a vpn connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: connectionName in: path required: true type: string description: The name of the vpn connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the vpn connection. schema: $ref: '#/definitions/VpnConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname tags: - Subscriptions put: operationId: microsoftAzureVpnconnectionsCreateorupdate x-ms-examples: VpnConnectionPut: $ref: ./examples/VpnConnectionPut.json description: Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: connectionName in: path required: true type: string description: The name of the connection. - $ref: ./network.json#/parameters/ApiVersionParameter - name: VpnConnectionParameters in: body required: true schema: $ref: '#/definitions/VpnConnection' description: Parameters supplied to create or Update a VPN Connection. responses: '200': description: Request successful. Returns the details of the vpn connection created or updated. schema: $ref: '#/definitions/VpnConnection' '201': description: Request successful. Returns the details of the vpn connection created or updated. schema: $ref: '#/definitions/VpnConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname tags: - Subscriptions delete: operationId: microsoftAzureVpnconnectionsDelete x-ms-examples: VpnConnectionDelete: $ref: ./examples/VpnConnectionDelete.json description: Deletes a vpn connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: connectionName in: path required: true type: string description: The name of the connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Vpn Connection deleted. '202': description: Request received successfully. Vpn Connection deletion is in progress; follow the Location header to poll for final outcome. '204': description: No vpn connections exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName} : get: operationId: microsoftAzureVpnsitelinkconnectionsGet x-ms-examples: VpnSiteLinkConnectionGet: $ref: ./examples/VpnSiteLinkConnectionGet.json description: Retrieves the details of a vpn site link connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: connectionName in: path required: true type: string description: The name of the vpn connection. - name: linkConnectionName in: path required: true type: string description: The name of the vpn connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the vpn connection. schema: $ref: '#/definitions/VpnSiteLinkConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname Vpnlinkconnections Linkconnectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/getikesas : post: operationId: microsoftAzureVpnlinkconnectionsGetikesas x-ms-examples: GetVpnLinkConnectionIkeSa: $ref: ./examples/VpnSiteLinkConnectionGetIkeSas.json description: Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: connectionName in: path required: true type: string description: The name of the vpn connection. - name: linkConnectionName in: path required: true type: string description: The name of the vpn link connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. The operation getikesas completed on vpn site link connection. schema: type: string '202': description: Accepted and the operation GetIkeSas will complete asynchronously. default: description: The operation GetIkeSas could not be completed. schema: $ref: ./networkWatcher.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname Vpnlinkconnections Linkconnectionname Getikesas tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/startpacketcapture : post: operationId: microsoftAzureVpnconnectionsStartpacketcapture description: Starts packet capture on Vpn connection in the specified resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: vpnConnectionName in: path required: true type: string description: The name of the vpn connection. - name: parameters in: body required: false schema: $ref: '#/definitions/VpnConnectionPacketCaptureStartParameters' description: Vpn Connection packet capture parameters supplied to start packet capture on gateway connection. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: Request successful. The operation packet capture started on vpn connection. schema: type: string '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: Start packet capture on vpn connection without filter: $ref: ./examples/VpnConnectionStartPacketCapture.json Start packet capture on vpn connection with filter: $ref: ./examples/VpnConnectionStartPacketCaptureFilterData.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Vpnconnectionname Startpacketcapture tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/stoppacketcapture : post: operationId: microsoftAzureVpnconnectionsStoppacketcapture description: Stops packet capture on Vpn connection in the specified resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: vpnConnectionName in: path required: true type: string description: The name of the vpn connection. - name: parameters in: body required: false schema: $ref: '#/definitions/VpnConnectionPacketCaptureStopParameters' description: Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: Request successful. The operation packet capture stopped on vpn connection. schema: type: string '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: Start packet capture on vpn connection without filter: $ref: ./examples/VpnConnectionStopPacketCapture.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Vpnconnectionname Stoppacketcapture tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections : get: operationId: microsoftAzureVpnconnectionsListbyvpngateway x-ms-examples: VpnConnectionList: $ref: ./examples/VpnConnectionList.json description: Retrieves all vpn connections for a particular virtual wan vpn gateway. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns all Vpn connections for a virtual wan vpn gateway. schema: $ref: '#/definitions/ListVpnConnectionsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections : get: operationId: microsoftAzureVpnlinkconnectionsListbyvpnconnection x-ms-examples: VpnSiteLinkConnectionList: $ref: ./examples/VpnSiteLinkConnectionList.json description: Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the vpn gateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: connectionName in: path required: true type: string description: The name of the vpn connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns all Vpn connections for a virtual wan vpn gateway. schema: $ref: '#/definitions/ListVpnSiteLinkConnectionsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname Vpnlinkconnections tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName} : get: operationId: microsoftAzureNatrulesGet x-ms-examples: NatRuleGet: $ref: ./examples/NatRuleGet.json description: Retrieves the details of a nat ruleGet. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: natRuleName in: path required: true type: string description: The name of the nat rule. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the nat rule. schema: $ref: '#/definitions/VpnGatewayNatRule' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Natrules Natrulename tags: - Subscriptions put: operationId: microsoftAzureNatrulesCreateorupdate x-ms-examples: NatRulePut: $ref: ./examples/NatRulePut.json description: Creates a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: natRuleName in: path required: true type: string description: The name of the nat rule. - $ref: ./network.json#/parameters/ApiVersionParameter - name: NatRuleParameters in: body required: true schema: $ref: '#/definitions/VpnGatewayNatRule' description: Parameters supplied to create or Update a Nat Rule. responses: '200': description: Request successful. Returns the details of the nat rule created or updated. schema: $ref: '#/definitions/VpnGatewayNatRule' '201': description: Request successful. Returns the details of the nat rule created or updated. schema: $ref: '#/definitions/VpnGatewayNatRule' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Natrules Natrulename tags: - Subscriptions delete: operationId: microsoftAzureNatrulesDelete x-ms-examples: NatRuleDelete: $ref: ./examples/NatRuleDelete.json description: Deletes a nat rule. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - name: natRuleName in: path required: true type: string description: The name of the nat rule. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Nat Rule deleted. '202': description: Request received successfully. Nat Rule deletion is in progress; follow the Location header to poll for final outcome. '204': description: No nat rules exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Natrules Natrulename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules : get: operationId: microsoftAzureNatrulesListbyvpngateway x-ms-examples: NatRuleList: $ref: ./examples/NatRuleList.json description: Retrieves all nat rules for a particular virtual wan vpn gateway. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns all Nat rules for a virtual wan vpn gateway. schema: $ref: '#/definitions/ListVpnGatewayNatRulesResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Natrules tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName} : get: operationId: microsoftAzureP2svpngatewaysGet x-ms-examples: P2SVpnGatewayGet: $ref: ./examples/P2SVpnGatewayGet.json description: Retrieves the details of a virtual wan p2s vpn gateway. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the P2SVpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved. schema: $ref: '#/definitions/P2SVpnGateway' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname tags: - Subscriptions put: operationId: microsoftAzureP2svpngatewaysCreateorupdate x-ms-examples: P2SVpnGatewayPut: $ref: ./examples/P2SVpnGatewayPut.json description: Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the P2SVpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - $ref: ./network.json#/parameters/ApiVersionParameter - name: p2SVpnGatewayParameters in: body required: true schema: $ref: '#/definitions/P2SVpnGateway' description: Parameters supplied to create or Update a virtual wan p2s vpn gateway. responses: '200': description: Request successful. Returns the details of the virtual wan p2s vpn Gateway created or updated. schema: $ref: '#/definitions/P2SVpnGateway' '201': description: Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved. schema: $ref: '#/definitions/P2SVpnGateway' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname tags: - Subscriptions delete: operationId: microsoftAzureP2svpngatewaysDelete x-ms-examples: P2SVpnGatewayDelete: $ref: ./examples/P2SVpnGatewayDelete.json description: Deletes a virtual wan p2s vpn gateway. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the P2SVpnGateway. - name: gatewayName in: path required: true type: string description: The name of the gateway. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. P2SVpnGateway deleted. '202': description: Request received successfully. P2SVpnGateway deletion is in progress; follow the Location header to poll for final outcome. '204': description: No p2s vpn gateways exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways: get: operationId: microsoftAzureP2svpngatewaysListbyresourcegroup x-ms-examples: P2SVpnGatewayListByResourceGroup: $ref: ./examples/P2SVpnGatewayListByResourceGroup.json description: Lists all the P2SVpnGateways in a resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the P2SVpnGateway. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the P2SVpnGateways in the resource group. schema: $ref: '#/definitions/ListP2SVpnGatewaysResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways: get: operationId: microsoftAzureP2svpngatewaysList x-ms-examples: P2SVpnGatewayListBySubscription: $ref: ./examples/P2SVpnGatewayList.json description: Lists all the P2SVpnGateways in a subscription. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the P2SVpnGateways in the subscription. schema: $ref: '#/definitions/ListP2SVpnGatewaysResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network P2svpngateways tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnServerConfigurations : post: operationId: microsoftAzureVpnserverconfigurationsassociatedwithvirtualwanList x-ms-examples: GetVirtualWanVpnServerConfigurations: $ref: ./examples/GetVirtualWanVpnServerConfigurations.json description: Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: virtualWANName in: path required: true type: string description: The name of the VirtualWAN whose associated VpnServerConfigurations is needed. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: List of associated VpnServerConfigurations list. schema: $ref: '#/definitions/VpnServerConfigurationsResponse' '202': description: Accepted and the operation will complete asynchronously. Follow the location header for list of associated VpnServerConfigurations list. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname Vpnserverconfigurations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/GenerateVpnProfile : post: operationId: microsoftAzureGeneratevirtualwanvpnserverconfigurationvpnprofile x-ms-examples: GenerateVirtualWanVpnServerConfigurationVpnProfile: $ref: ./examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json description: Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: virtualWANName in: path required: true type: string description: The name of the VirtualWAN whose associated VpnServerConfigurations is needed. - name: vpnClientParams in: body required: true schema: $ref: '#/definitions/VirtualWanVpnProfileParameters' description: Parameters supplied to the generate VirtualWan VPN profile generation operation. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: VPN profile package URL. schema: $ref: '#/definitions/VpnProfileResponse' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname Generatevpnprofile tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName} : get: operationId: microsoftAzureVirtualhubroutetablev2sGet x-ms-examples: VirtualHubVirtualHubRouteTableV2Get: $ref: ./examples/VirtualHubRouteTableV2Get.json description: Retrieves the details of a VirtualHubRouteTableV2. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHubRouteTableV2. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routeTableName in: path required: true type: string description: The name of the VirtualHubRouteTableV2. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the VirtualHubRouteTableV2 retrieved. schema: $ref: '#/definitions/VirtualHubRouteTableV2' default: description: Error. schema: $ref: ./network.json#/definitions/Error summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routetables Routetablename tags: - Subscriptions put: operationId: microsoftAzureVirtualhubroutetablev2sCreateorupdate x-ms-examples: VirtualHubRouteTableV2Put: $ref: ./examples/VirtualHubRouteTableV2Put.json description: Creates a VirtualHubRouteTableV2 resource if it doesn't exist else updates the existing VirtualHubRouteTableV2. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routeTableName in: path required: true type: string description: The name of the VirtualHubRouteTableV2. - $ref: ./network.json#/parameters/ApiVersionParameter - name: virtualHubRouteTableV2Parameters in: body required: true schema: $ref: '#/definitions/VirtualHubRouteTableV2' description: Parameters supplied to create or update VirtualHubRouteTableV2. responses: '200': description: Request successful. Returns the details of the VirtualHubRouteTableV2 created or updated. schema: $ref: '#/definitions/VirtualHubRouteTableV2' '201': description: Request received successfully. Returns the details of the VirtualHubRouteTableV2 created or updated. schema: $ref: '#/definitions/VirtualHubRouteTableV2' default: description: Error. schema: $ref: ./network.json#/definitions/Error x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routetables Routetablename tags: - Subscriptions delete: operationId: microsoftAzureVirtualhubroutetablev2sDelete x-ms-examples: VirtualHubRouteTableV2Delete: $ref: ./examples/VirtualHubRouteTableV2Delete.json description: Deletes a VirtualHubRouteTableV2. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHubRouteTableV2. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routeTableName in: path required: true type: string description: The name of the VirtualHubRouteTableV2. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VirtualHubRouteTableV2 deleted. '202': description: Request received successfully. VirtualHubRouteTableV2 deletion is in progress; follow the Location header to poll for final outcome. '204': description: No VirtualHubRouteTableV2s exist by the name provided. default: description: Error. schema: $ref: ./network.json#/definitions/Error x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routetables Routetablename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables : get: operationId: microsoftAzureVirtualhubroutetablev2sList x-ms-examples: VirtualHubRouteTableV2List: $ref: ./examples/VirtualHubRouteTableV2List.json description: Retrieves the details of all VirtualHubRouteTableV2s. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VirtualHubRouteTableV2s for the VirtualHub. schema: $ref: '#/definitions/ListVirtualHubRouteTableV2sResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routetables tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName} : put: operationId: microsoftAzureNetworkvirtualapplianceconnectionsCreateorupdate x-ms-examples: NetworkVirtualApplianceConnectionPut: $ref: ./examples/NetworkVirtualApplianceConnectionPut.json description: Creates a connection to Network Virtual Appliance, if it doesn't exist else updates the existing NVA connection' parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: networkVirtualApplianceName in: path required: true type: string pattern: ^[A-Za-z0-9_]+ description: The name of the Network Virtual Appliance. - name: connectionName in: path required: true type: string pattern: ^[A-Za-z0-9_]+ description: The name of the NVA connection. - $ref: ./network.json#/parameters/ApiVersionParameter - name: NetworkVirtualApplianceConnectionParameters in: body required: true schema: $ref: '#/definitions/NetworkVirtualApplianceConnection' description: Parameters supplied in an NetworkVirtualApplianceConnection PUT operation. responses: '200': description: Update successful. Returns the details of the NVA connection created or updated. schema: $ref: '#/definitions/NetworkVirtualApplianceConnection' '201': description: Create successful. Returns the details of the NVA connection created or updated. schema: $ref: '#/definitions/NetworkVirtualApplianceConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkvirtualappliances Networkvirtualappliancename Networkvirtualapplianceconnections Connectionname tags: - Subscriptions get: operationId: microsoftAzureNetworkvirtualapplianceconnectionsGet x-ms-examples: NetworkVirtualApplianceConnectionGet: $ref: ./examples/NetworkVirtualApplianceConnectionGet.json description: Retrieves the details of specified NVA connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: networkVirtualApplianceName in: path required: true type: string description: The name of the Network Virtual Appliance. - name: connectionName in: path required: true type: string description: The name of the NVA connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the NVA connection schema: $ref: '#/definitions/NetworkVirtualApplianceConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkvirtualappliances Networkvirtualappliancename Networkvirtualapplianceconnections Connectionname tags: - Subscriptions delete: operationId: microsoftAzureNetworkvirtualapplianceconnectionsDelete x-ms-examples: NetworkVirtualApplianceConnectionDelete: $ref: ./examples/NetworkVirtualApplianceConnectionDelete.json description: Deletes a NVA connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: networkVirtualApplianceName in: path required: true type: string description: The name of the Network Virtual Appliance. - name: connectionName in: path required: true type: string description: The name of the NVA connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Delete successful.NVA Connection deleted. '202': description: Accepted, and the operation will continue asynchronously. headers: location: description: The URL of the resource used to check the status of the asynchronous operation. type: string '204': description: No NVA connections exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkvirtualappliances Networkvirtualappliancename Networkvirtualapplianceconnections Connectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections : get: operationId: microsoftAzureNetworkvirtualapplianceconnectionsList x-ms-examples: NetworkVirtualApplianceConnectionList: $ref: ./examples/NetworkVirtualApplianceConnectionList.json description: Lists NetworkVirtualApplianceConnections under the NVA. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: networkVirtualApplianceName in: path required: true type: string pattern: ^[A-Za-z0-9_]+ description: The name of the Network Virtual Appliance. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Lists all the NVA connections under an NVA. schema: $ref: '#/definitions/NetworkVirtualApplianceConnectionList' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkvirtualappliances Networkvirtualappliancename Networkvirtualapplianceconnections tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName} : get: operationId: microsoftAzureVirtualhubbgpconnectionGet x-ms-examples: VirtualHubVirtualHubRouteTableV2Get: $ref: ./examples/VirtualHubBgpConnectionGet.json description: Retrieves the details of a Virtual Hub Bgp Connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: connectionName in: path required: true type: string description: The name of the connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the Bgp Connection retrieved. schema: $ref: '#/definitions/BgpConnection' default: description: Error. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Bgpconnections Connectionname tags: - Subscriptions put: operationId: microsoftAzureVirtualhubbgpconnectionCreateorupdate x-ms-examples: VirtualHubRouteTableV2Put: $ref: ./examples/VirtualHubBgpConnectionPut.json description: Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: connectionName in: path required: true type: string description: The name of the connection. - $ref: ./network.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/BgpConnection' description: Parameters of Bgp connection. responses: '200': description: Request successful. Returns the details of the BgpConnection created or updated. schema: $ref: '#/definitions/BgpConnection' '201': description: Request received successfully. Returns the details of the BgpConnection created or updated. schema: $ref: '#/definitions/BgpConnection' default: description: Error. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Bgpconnections Connectionname tags: - Subscriptions delete: operationId: microsoftAzureVirtualhubbgpconnectionDelete x-ms-examples: VirtualHubRouteTableV2Delete: $ref: ./examples/VirtualHubBgpConnectionDelete.json description: Deletes a VirtualHubBgpConnection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHubBgpConnection. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: connectionName in: path required: true type: string description: The name of the connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VirtualHubBgpConnection deleted. '202': description: Request received successfully. VirtualHubBgpConnection deletion is in progress; follow the Location header to poll for final outcome. '204': description: No VirtualHubBgpConnection exist by the name provided. default: description: Error. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Bgpconnections Connectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections : get: operationId: microsoftAzureVirtualhubbgpconnectionsList x-ms-examples: VirtualHubRouteTableV2List: $ref: ./examples/VirtualHubBgpConnectionList.json description: Retrieves the details of all VirtualHubBgpConnections. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VirtualHubBgpConnections for the VirtualHub. schema: $ref: '#/definitions/ListVirtualHubBgpConnectionResults' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Bgpconnections tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/learnedRoutes : post: operationId: microsoftAzureVirtualhubbgpconnectionsListlearnedroutes description: Retrieves a list of routes the virtual hub bgp connection has learned. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the virtual hub. - name: connectionName in: path required: true type: string description: The name of the virtual hub bgp connection. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: List of advertised BGP routes. schema: $ref: '#/definitions/PeerRouteList' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: VirtualRouterPeerListLearnedRoutes: $ref: ./examples/VirtualRouterPeerListLearnedRoute.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Hubname Bgpconnections Connectionname Learnedroutes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/advertisedRoutes : post: operationId: microsoftAzureVirtualhubbgpconnectionsListadvertisedroutes description: Retrieves a list of routes the virtual hub bgp connection is advertising to the specified peer. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the virtual hub. - name: connectionName in: path required: true type: string description: The name of the virtual hub bgp connection. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: List of learned BGP routes. schema: $ref: '#/definitions/PeerRouteList' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: VirtualRouterPeerListAdvertisedRoutes: $ref: ./examples/VirtualRouterPeerListAdvertisedRoute.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Hubname Bgpconnections Connectionname Advertisedroutes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName} : get: operationId: microsoftAzureVirtualhubipconfigurationGet x-ms-examples: VirtualHubVirtualHubRouteTableV2Get: $ref: ./examples/VirtualHubIpConfigurationGet.json description: Retrieves the details of a Virtual Hub Ip configuration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: ipConfigName in: path required: true type: string description: The name of the ipconfig. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the Bgp Connection retrieved. schema: $ref: '#/definitions/HubIpConfiguration' default: description: Error. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Ipconfigurations Ipconfigname tags: - Subscriptions put: operationId: microsoftAzureVirtualhubipconfigurationCreateorupdate x-ms-examples: VirtualHubIpConfigurationPut: $ref: ./examples/VirtualHubIpConfigurationPut.json description: Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: ipConfigName in: path required: true type: string description: The name of the ipconfig. - $ref: ./network.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/HubIpConfiguration' description: Hub Ip Configuration parameters. responses: '200': description: Request successful. Returns the details of the IpConfiguration created or updated. schema: $ref: '#/definitions/HubIpConfiguration' '201': description: Request received successfully. Returns the details of the IpConfiguration created or updated. schema: $ref: '#/definitions/HubIpConfiguration' default: description: Error. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Ipconfigurations Ipconfigname tags: - Subscriptions delete: operationId: microsoftAzureVirtualhubipconfigurationDelete x-ms-examples: VirtualHubIpConfigurationDelete: $ref: ./examples/VirtualHubIpConfigurationDelete.json description: Deletes a VirtualHubIpConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHubBgpConnection. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: ipConfigName in: path required: true type: string description: The name of the ipconfig. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VirtualHubIpConfiguration deleted. '202': description: Request received successfully. VirtualHubIpConfiguration deletion is in progress; follow the Location header to poll for final outcome. '204': description: No VirtualHubIpConfiguration exist by the name provided. default: description: Error. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Ipconfigurations Ipconfigname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations : get: operationId: microsoftAzureVirtualhubipconfigurationList x-ms-examples: VirtualHubRouteTableV2List: $ref: ./examples/VirtualHubIpConfigurationList.json description: Retrieves the details of all VirtualHubIpConfigurations. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the VirtualHubIpConfigurations for the VirtualHub. schema: $ref: '#/definitions/ListVirtualHubIpConfigurationResults' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Ipconfigurations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName} : put: operationId: microsoftAzureHubroutetablesCreateorupdate x-ms-examples: RouteTablePut: $ref: ./examples/HubRouteTablePut.json description: Creates a RouteTable resource if it doesn't exist else updates the existing RouteTable. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routeTableName in: path required: true type: string description: The name of the RouteTable. - $ref: ./network.json#/parameters/ApiVersionParameter - name: routeTableParameters in: body required: true schema: $ref: '#/definitions/HubRouteTable' description: Parameters supplied to create or update RouteTable. responses: '200': description: Request successful. Returns the details of the RouteTable created or updated. schema: $ref: '#/definitions/HubRouteTable' '201': description: Request received successfully. Returns the details of the RouteTable created or updated. schema: $ref: '#/definitions/HubRouteTable' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubroutetables Routetablename tags: - Subscriptions get: operationId: microsoftAzureHubroutetablesGet x-ms-examples: RouteTableGet: $ref: ./examples/HubRouteTableGet.json description: Retrieves the details of a RouteTable. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routeTableName in: path required: true type: string description: The name of the RouteTable. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the RouteTable retrieved. schema: $ref: '#/definitions/HubRouteTable' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubroutetables Routetablename tags: - Subscriptions delete: operationId: microsoftAzureHubroutetablesDelete x-ms-examples: RouteTableDelete: $ref: ./examples/HubRouteTableDelete.json description: Deletes a RouteTable. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RouteTable. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routeTableName in: path required: true type: string description: The name of the RouteTable. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. RouteTable deleted. '202': description: Request received successfully. RouteTable deletion is in progress; follow the Location header to poll for final outcome. '204': description: No RouteTables exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubroutetables Routetablename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables : get: operationId: microsoftAzureHubroutetablesList x-ms-examples: RouteTableList: $ref: ./examples/HubRouteTableList.json description: Retrieves the details of all RouteTables. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the RouteTables for the VirtualHub. schema: $ref: '#/definitions/ListHubRouteTablesResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubroutetables tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/effectiveRoutes : post: operationId: microsoftAzureVirtualhubsGeteffectivevirtualhubroutes x-ms-examples: Effective Routes for the Virtual Hub: $ref: ./examples/EffectiveRoutesListForVirtualHub.json Effective Routes for a Route Table resource: $ref: ./examples/EffectiveRoutesListForRouteTable.json Effective Routes for a Connection resource: $ref: ./examples/EffectiveRoutesListForConnection.json description: Gets the effective routes configured for the Virtual Hub resource or the specified resource . parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter - name: effectiveRoutesParameters in: body required: false schema: $ref: '#/definitions/EffectiveRoutesParameters' description: Parameters supplied to get the effective routes for a specific resource. responses: '200': description: Request successful. Returns the list of the effective routes or follow the location header for the effective routes list. schema: $ref: '#/definitions/VirtualHubEffectiveRouteList' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Effectiveroutes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/inboundRoutes : post: operationId: microsoftAzureVirtualhubsGetinboundroutes x-ms-examples: Inbound Routes for the Virtual Hub on a Particular Connection: $ref: ./examples/GetInboundRoutes.json description: Gets the inbound routes configured for the Virtual Hub on a particular connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter - name: getInboundRoutesParameters in: body required: true schema: $ref: '#/definitions/GetInboundRoutesParameters' description: Parameters supplied to get the inbound routes for a connection resource. responses: '200': description: Request successful. Returns the list of the effective route map routes or follow the location header for the inbound routes list. schema: $ref: '#/definitions/EffectiveRouteMapRouteList' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Inboundroutes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/outboundRoutes : post: operationId: microsoftAzureVirtualhubsGetoutboundroutes x-ms-examples: Outbound Routes for the Virtual Hub on a Particular Connection: $ref: ./examples/GetOutboundRoutes.json description: Gets the outbound routes configured for the Virtual Hub on a particular connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter - name: getOutboundRoutesParameters in: body required: true schema: $ref: '#/definitions/GetOutboundRoutesParameters' description: Parameters supplied to get the outbound routes for a connection resource. responses: '200': description: Request successful. Returns the list of the effective route map routes or follow the location header for the outbound routes list. schema: $ref: '#/definitions/EffectiveRouteMapRouteList' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Outboundroutes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName} : put: operationId: microsoftAzureRoutingintentCreateorupdate x-ms-examples: RouteTablePut: $ref: ./examples/RoutingIntentPut.json description: Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RoutingIntent. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routingIntentName in: path required: true type: string description: The name of the per VirtualHub singleton Routing Intent resource. - $ref: ./network.json#/parameters/ApiVersionParameter - name: routingIntentParameters in: body required: true schema: $ref: '#/definitions/RoutingIntent' description: Parameters supplied to create or update RoutingIntent. responses: '200': description: Request successful. Returns the details of the RoutingIntent created or updated. schema: $ref: '#/definitions/RoutingIntent' '201': description: Request received successfully. Returns the details of the RoutingIntent created or updated. schema: $ref: '#/definitions/RoutingIntent' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routingintent Routingintentname tags: - Subscriptions get: operationId: microsoftAzureRoutingintentGet x-ms-examples: RouteTableGet: $ref: ./examples/RoutingIntentGet.json description: Retrieves the details of a RoutingIntent. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RoutingIntent. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routingIntentName in: path required: true type: string description: The name of the RoutingIntent. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the RoutingIntent retrieved. schema: $ref: '#/definitions/RoutingIntent' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routingintent Routingintentname tags: - Subscriptions delete: operationId: microsoftAzureRoutingintentDelete x-ms-examples: RouteTableDelete: $ref: ./examples/RoutingIntentDelete.json description: Deletes a RoutingIntent. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RoutingIntent. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routingIntentName in: path required: true type: string description: The name of the RoutingIntent. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. RoutingIntent deleted. '202': description: Request received successfully. RoutingIntent deletion is in progress; follow the Location header to poll for final outcome. '204': description: No RoutingIntent exists by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routingintent Routingintentname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent : get: operationId: microsoftAzureRoutingintentList x-ms-examples: RoutingIntentList: $ref: ./examples/RoutingIntentList.json description: Retrieves the details of all RoutingIntent child resources of the VirtualHub. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHub. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of all the RoutingIntent resources for the VirtualHub. schema: $ref: '#/definitions/ListRoutingIntentResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routingintent tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors : get: summary: 'Microsoft Azure Get The Current Health Status Of All Monitors Of A Virtual Machine Optional Parameters: $expand Retrieve The Monitor S Evidence And Configuration And $filter Filter By Monitor Name' operationId: microsoftAzureHealthmonitorsList produces: - application/json x-ms-pageable: nextLinkName: nextLink parameters: - $ref: '#/parameters/api-version_3' - $ref: '#/parameters/subscriptionId_7' - $ref: '#/parameters/resourceGroupName_6' - $ref: '#/parameters/providerName' - $ref: '#/parameters/resourceCollectionName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/monitorNameFilter' - $ref: '#/parameters/expand' responses: '200': description: The health monitors matching the specified criteria. schema: $ref: '#/definitions/HealthMonitorList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_10' x-ms-examples: Get monitor list with default values: $ref: ./examples/MonitorList_GetDefault.json Get monitor list with filtered values: $ref: ./examples/MonitorList_GetFiltered.json Get monitor list with expanded values: $ref: ./examples/MonitorList_GetExpanded.json description: Needs a more full description created. tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId} : get: summary: 'Microsoft Azure Get The Current Health Status Of A Monitor Of A Virtual Machine Optional Parameter: $expand Retrieve The Monitor S Evidence And Configuration' operationId: microsoftAzureHealthmonitorsGet produces: - application/json parameters: - $ref: '#/parameters/api-version_3' - $ref: '#/parameters/subscriptionId_7' - $ref: '#/parameters/resourceGroupName_6' - $ref: '#/parameters/providerName' - $ref: '#/parameters/resourceCollectionName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/monitorId' - $ref: '#/parameters/expand' responses: '200': description: The health monitor matching the specified criteria. schema: $ref: '#/definitions/HealthMonitor' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_10' x-ms-examples: Get monitor with default values: $ref: ./examples/Monitor_GetDefault.json Get monitor with expanded values: $ref: ./examples/Monitor_GetExpanded.json description: Needs a more full description created. tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}/history : get: summary: 'Microsoft Azure Get The Health State Changes Of A Monitor Of A Virtual Machine Within The Provided Time Window Default Is The Last 24 Hours Optional Parameters: $expand Retrieve The Monitor S Evidence And Configuration And $filter Filter By Heartbeat Condition' operationId: microsoftAzureHealthmonitorsListstatechanges x-ms-pageable: nextLinkName: nextLink produces: - application/json parameters: - $ref: '#/parameters/api-version_3' - $ref: '#/parameters/subscriptionId_7' - $ref: '#/parameters/resourceGroupName_6' - $ref: '#/parameters/providerName' - $ref: '#/parameters/resourceCollectionName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/monitorId' - $ref: '#/parameters/heartbeatFilter' - $ref: '#/parameters/expand' - in: query name: startTimestampUtc description: The start of the time window. required: false type: string format: date-time - in: query name: endTimestampUtc description: The end of the time window. required: false type: string format: date-time responses: '200': description: The health monitor state changes matching the specified criteria. schema: $ref: '#/definitions/HealthMonitorStateChangeList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_10' x-ms-examples: Get monitor state changes with default values: $ref: ./examples/MonitorHistory_GetDefault.json Get monitor state changes with filtered values: $ref: ./examples/MonitorHistory_GetFiltered.json Get monitor state changes with expanded values: $ref: ./examples/MonitorHistory_GetExpanded.json description: Needs a more full description created. tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}/history/{timestampUnix} : get: summary: 'Microsoft Azure Get The Health State Change Of A Monitor Of A Virtual Machine At The Provided Timestamp Optional Parameter: $expand Retrieve The Monitor S Evidence And Configuration' operationId: microsoftAzureHealthmonitorsGetstatechange produces: - application/json parameters: - $ref: '#/parameters/api-version_3' - $ref: '#/parameters/subscriptionId_7' - $ref: '#/parameters/resourceGroupName_6' - $ref: '#/parameters/providerName' - $ref: '#/parameters/resourceCollectionName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/monitorId' - $ref: '#/parameters/timestampUnix' - $ref: '#/parameters/expand' responses: '200': description: The health monitor state change matching the specified criteria. schema: $ref: '#/definitions/HealthMonitorStateChange' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_10' x-ms-examples: Get monitor state change with default values: $ref: ./examples/MonitorStateChange_GetDefault.json Get monitor state change with expanded values: $ref: ./examples/MonitorStateChange_GetExpanded.json description: Needs a more full description created. tags: - Subscriptions components: schemas: ErrorResponse: type: object description: Common error response for all Azure Resource Manager APIs. properties: code: type: string readOnly: true description: The error code. example: example_value message: type: string readOnly: true description: The error message. example: example_value target: type: string readOnly: true description: The error target. example: example_value details: type: array readOnly: true items: $ref: '#/components/schemas/ErrorResponse' description: The error details. example: [] additionalInfo: type: array readOnly: true items: $ref: '#/components/schemas/ErrorAdditionalInfo' description: The error additional info. example: [] TagsListResult: type: object description: List of subscription tags. properties: value: type: array items: $ref: '#/components/schemas/TagDetails' description: An array of tags. example: [] nextLink: type: string readOnly: true description: The URL to get the next set of results. example: example_value ErrorAdditionalInfo: type: object description: The resource management error additional info. properties: type: type: string readOnly: true description: The additional info type. example: example_value info: type: object readOnly: true description: The additional info. example: example_value Subscription: type: object description: Subscription information. properties: id: type: string readOnly: true description: The fully qualified ID for the subscription. example: abc123 subscriptionId: type: string readOnly: true description: The subscription ID. example: '500123' displayName: type: string readOnly: true description: The subscription display name. example: example_value tenantId: type: string readOnly: true description: The subscription tenant ID. example: '500123' state: type: string readOnly: true description: The subscription state. enum: - Enabled - Warned - PastDue - Disabled - Deleted example: Enabled subscriptionPolicies: $ref: '#/components/schemas/SubscriptionPolicies' authorizationSource: type: string description: The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct, Management. example: example_value tags: type: object additionalProperties: type: string description: The tags attached to the subscription. example: example_value SubscriptionListResult: type: object description: Subscription list operation response. properties: value: type: array items: $ref: '#/components/schemas/Subscription' description: An array of subscriptions. example: [] nextLink: type: string description: The URL to get the next set of results. example: example_value required: - value TagCount: type: object description: Tag count. properties: type: type: string description: Type of count. example: example_value value: type: integer format: int32 description: Value of count. example: 10 TagDetails: type: object description: Tag details. properties: id: type: string readOnly: true description: The tag name ID. example: abc123 tagName: type: string description: The tag name. example: example_value count: $ref: '#/components/schemas/TagCount' values: type: array items: $ref: '#/components/schemas/TagValue' description: The list of tag values. example: [] SubscriptionPolicies: type: object description: Subscription policies. properties: locationPlacementId: type: string readOnly: true description: The subscription location placement ID. example: '500123' quotaId: type: string readOnly: true description: The subscription quota ID. example: '500123' spendingLimit: type: string readOnly: true description: The subscription spending limit. enum: - 'On' - 'Off' - CurrentPeriodOff example: 'On' TagValue: type: object description: Tag information. properties: id: type: string readOnly: true description: The tag value ID. example: abc123 tagValue: type: string description: The tag value. example: example_value count: $ref: '#/components/schemas/TagCount' CloudError: type: object description: An error response for a resource management request. properties: error: $ref: '#/components/schemas/ErrorResponse' parameters: ApiVersionParameter: name: api-version in: query required: true description: The API version to use for this operation. schema: type: string default: '2024-03-01' SubscriptionIdParameter: name: subscriptionId in: path required: true description: The ID of the target subscription. schema: type: string format: uuid definitions: HubIPConfigurationPropertiesFormat: properties: privateIPAddress: type: string description: The private IP address of the IP configuration. privateIPAllocationMethod: $ref: ./network.json#/definitions/IPAllocationMethod description: The private IP address allocation method. subnet: $ref: ./virtualNetwork.json#/definitions/Subnet description: The reference to the subnet resource. publicIPAddress: $ref: ./publicIpAddress.json#/definitions/PublicIPAddress description: The reference to the public IP resource. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the IP configuration resource. description: Properties of IP configuration. ClusterPoolProfile: type: object description: Cluster pool profile. required: - clusterPoolVersion properties: clusterPoolVersion: $ref: '#/definitions/ClusterPoolVersionPattern' DnsResourceReferenceResult: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/DnsResourceReferenceResultProperties' description: The result of dns resource reference request. Returns a list of dns resource references for each of the azure resource in the request. description: Represents the properties of the Dns Resource Reference Result. AzureDevOpsConnectorProperties: type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState_3' authorization: $ref: '#/definitions/AuthorizationInfo' orgs: description: Gets or sets org onboarding information. type: array items: $ref: '#/definitions/AzureDevOpsOrgMetadata' x-ms-identifiers: [] ServiceEndpointResourceList: description: The list of ServiceEndpoint resources. type: object properties: nextLink: description: The link used to get the next page of ServiceEndpoint resources list. type: string value: description: The list of ServiceEndpoint resources. type: array items: $ref: '#/definitions/ServiceEndpointResource' ActionGroupList: description: A list of action groups. type: object properties: value: x-ms-identifiers: [] type: array items: $ref: '#/definitions/ActionGroupResource' description: The list of action groups. nextLink: type: string description: Provides the link to retrieve the next set of elements. Resource_5: properties: id: type: string readOnly: true description: Azure resource Id name: type: string readOnly: true description: Azure resource name type: type: string readOnly: true description: Azure resource type location: type: string description: Resource location x-ms-mutability: - create - read tags: additionalProperties: type: string description: Resource tags required: - location x-ms-azure-resource: true description: An azure resource object GuestDiagnosticSettingsAssociation: description: A guest diagnostic settings association. properties: guestDiagnosticSettingsName: type: string description: The guest diagnostic settings name. required: - guestDiagnosticSettingsName RuleCategory: enum: - Code - Artifacts - Dependencies - Secrets - IaC - Containers type: string x-ms-enum: name: RuleCategory modelAsString: true modelAsExtensible: true SecurityContextCapabilitiesDefinition: description: The capabilities to add or drop from a container. type: object properties: add: type: array items: type: string description: The capabilities to add to the container. drop: type: array items: type: string description: The capabilities to drop from the container. ControlPlaneNodeConfiguration: type: object title: ControlPlaneNodeConfiguration represents the selection of virtual machines and size of the control plane for a Kubernetes cluster. required: - count - vmSkuName properties: administratorConfiguration: $ref: '#/definitions/AdministratorConfiguration' description: The administrator credentials to be used for the nodes in the control plane. x-ms-mutability: - read - create availabilityZones: description: The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used. type: array items: type: string x-ms-mutability: - read - create count: description: The number of virtual machines that use this configuration. type: integer format: int64 minimum: 1 vmSkuName: description: The name of the VM SKU supplied during creation. type: string x-ms-mutability: - read - create AccountUpdate: description: Request payload used to update and existing Accounts. type: object properties: identity: $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity description: The type of identity used for the resource. location: type: string description: The geo-location where the resource lives allOf: - $ref: '#/definitions/TagUpdate' table: title: A query response table. description: Contains the columns and rows for one table in a query response. type: object properties: name: description: The name of the table. type: string columns: description: The list of columns in this table. type: array items: $ref: '#/definitions/column' rows: description: The resulting rows from this query. type: array items: type: array items: type: string required: - name - columns - rows TrinoTelemetryConfig: type: object description: Trino user telemetry definition. properties: hivecatalogName: type: string description: Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created. minLength: 1 hivecatalogSchema: type: string description: Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs. default: trinologs partitionRetentionInDays: type: integer description: Retention period for query log table partitions, this doesn't have any affect on actual data. format: int32 default: 365 path: type: string description: Azure storage location of the blobs. minLength: 1 L3Network: type: object title: L3Network represents a network that utilizes a single isolation domain set up for layer-3 resources. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/L3NetworkProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true CloudHsmClusterSku: type: object description: Cloud Hsm Cluster SKU information required: - name - family properties: family: type: string description: Sku family of the Cloud HSM Cluster enum: - B x-ms-client-default: B x-ms-enum: name: CloudHsmClusterSkuFamily modelAsString: true name: type: string description: Sku name of the Cloud HSM Cluster enum: - Standard_B1 - Standard B10 x-ms-enum: name: CloudHsmClusterSkuName modelAsString: false capacity: format: int32 type: integer description: Sku capacity ErrorResponseLinkedStorage: type: object properties: error: description: Error response indicates Insights service is not able to process the incoming request. The reason is provided in the error message. type: object properties: code: readOnly: true description: Error code. type: string message: readOnly: true description: Error message indicating why the operation failed. type: string VpnSiteLinkProperties: properties: linkProperties: description: The link provider properties. $ref: '#/definitions/VpnLinkProviderProperties' ipAddress: type: string description: The ip-address for the vpn-site-link. fqdn: type: string description: FQDN of vpn-site-link. bgpProperties: $ref: '#/definitions/VpnLinkBgpSettings' description: The set of bgp properties. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the VPN site link resource. description: Parameters for VpnSite. GetOutboundRoutesParameters: description: The parameters specifying the connection resource whose outbound routes are being requested. type: object properties: resourceUri: type: string description: The connection resource whose outbound routes are being requested. connectionType: type: string description: The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection. VpnGatewayProperties: properties: virtualHub: $ref: ./network.json#/definitions/SubResource description: The VirtualHub to which the gateway belongs. connections: type: array description: List of all vpn connections to the gateway. items: $ref: '#/definitions/VpnConnection' bgpSettings: $ref: ./virtualNetworkGateway.json#/definitions/BgpSettings description: Local network gateway's BGP speaker settings. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the VPN gateway resource. vpnGatewayScaleUnit: type: integer format: int32 description: The scale unit for this vpn gateway. ipConfigurations: type: array readOnly: true description: List of all IPs configured on the gateway. items: $ref: '#/definitions/VpnGatewayIpConfiguration' enableBgpRouteTranslationForNat: type: boolean description: Enable BGP routes translation for NAT on this VpnGateway. isRoutingPreferenceInternet: type: boolean description: Enable Routing Preference property for the Public IP Interface of the VpnGateway. natRules: type: array description: List of all the nat Rules associated with the gateway. items: $ref: '#/definitions/VpnGatewayNatRule' description: Parameters for VpnGateway. ClusterResource: description: Representation of a managed Cassandra cluster. type: object allOf: - $ref: '#/definitions/ManagedCassandraARMResourceProperties' properties: properties: type: object description: Properties of a managed Cassandra cluster. properties: provisioningState: $ref: '#/definitions/ManagedCassandraProvisioningState' restoreFromBackupId: type: string x-ms-mutability: - create description: To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. delegatedManagementSubnetId: type: string x-ms-mutability: - create - read description: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' cassandraVersion: type: string description: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. clusterNameOverride: type: string x-ms-mutability: - create - read description: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. authenticationMethod: type: string description: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. enum: - None - Cassandra - Ldap x-ms-enum: name: AuthenticationMethod modelAsString: true initialCassandraAdminPassword: x-ms-mutability: - create x-ms-secret: true description: Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. type: string prometheusEndpoint: $ref: '#/definitions/SeedNode' description: Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. repairEnabled: type: boolean description: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. autoReplicate: type: string description: The form of AutoReplicate that is being used by this cluster. enum: - None - SystemKeyspaces - AllKeyspaces x-ms-enum: name: AutoReplicate modelAsString: true clientCertificates: description: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. type: array items: $ref: '#/definitions/Certificate' externalGossipCertificates: description: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. type: array items: $ref: '#/definitions/Certificate' gossipCertificates: readOnly: true x-ms-mutability: - read description: List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. type: array items: $ref: '#/definitions/Certificate' externalSeedNodes: type: array description: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. items: $ref: '#/definitions/SeedNode' seedNodes: readOnly: true type: array items: $ref: '#/definitions/SeedNode' description: List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. externalDataCenters: type: array description: List of the data center names for unmanaged data centers in this cluster to be included in auto-replication. items: type: string hoursBetweenBackups: type: integer format: int32 description: (Deprecated) Number of hours to wait between taking a backup of the cluster. deallocated: type: boolean description: Whether the cluster and associated data centers has been deallocated. cassandraAuditLoggingEnabled: type: boolean description: Whether Cassandra audit logging is enabled clusterType: type: string description: Type of the cluster. If set to Production, some operations might not be permitted on cluster. enum: - Production - NonProduction x-ms-enum: name: ClusterType modelAsString: true provisionError: $ref: '#/definitions/CassandraError' description: Error related to resource provisioning. extensions: type: array description: Extensions to be added or updated on cluster. items: type: string backupSchedules: type: array items: $ref: '#/definitions/BackupSchedule' description: List of backup schedules that define when you want to back up your data. scheduledEventStrategy: type: string description: How the nodes in the cluster react to scheduled events enum: - Ignore - StopAny - StopByRack x-ms-enum: name: ScheduledEventStrategy modelAsString: true azureConnectionMethod: type: string description: How to connect to the azure services needed for running the cluster enum: - None - VPN x-ms-enum: name: AzureConnectionType modelAsString: true privateLinkResourceId: type: string readOnly: true description: If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to. metadataResults: title: A metadata response. description: The metadata result for the app, including available tables, etc. type: object properties: tableGroups: description: The list of groups of tables on the app. type: array items: $ref: '#/definitions/metadataTableGroup' uniqueItems: true tables: description: The list of tables and columns that comprise the schema of the app. type: array items: $ref: '#/definitions/metadataTable' uniqueItems: true functions: description: The list of functions stored on the app. type: array items: $ref: '#/definitions/metadataFunction' uniqueItems: true applications: description: The list of Application Insights apps that were referenced in the metadata request. type: array items: $ref: '#/definitions/metadataApplication' uniqueItems: true EgressEndpoint: type: object title: EgressEndpoint represents the connection from a cloud services network to the specified endpoint for a common purpose. required: - category - endpoints properties: category: description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. type: string endpoints: description: The list of endpoint dependencies. type: array minItems: 1 items: $ref: '#/definitions/EndpointDependency' x-ms-identifiers: [] metadataApplication: title: An Application Insights application. description: Application Insights apps that were part of the metadata request and that the user has access to. type: object properties: id: description: The ID of the Application Insights app. type: string resourceId: description: The ARM resource ID of the Application Insights app. type: string name: description: The name of the Application Insights app. type: string region: description: The Azure region of the Application Insights app. type: string tables: description: The list of custom tables for the Application Insights app. type: array items: type: string functions: description: The list of stored functions on the Application Insights app type: array items: type: string tableGroups: description: The list of table groups on the Application Insights app type: array items: type: string required: - id - resourceId - name - region ContainerVolume: description: Describes how a volume is attached to a container. type: object properties: name: description: Name of the volume. type: string readOnly: description: The flag indicating whether the volume is read only. Default is 'false'. type: boolean destinationPath: description: The path within the container at which the volume should be mounted. Only valid path characters are allowed. type: string required: - name - destinationPath AccountResource: type: object description: Account details allOf: - $ref: '#/definitions/Resource_4' required: - properties properties: systemData: description: Metadata pertaining to creation and last modification of the resource. type: object readOnly: true properties: createdByType: type: string description: The type of identity that created the resource. enum: - User - Application - ManagedIdentity - Key x-ms-enum: name: createdByType modelAsString: true createdAt: type: string format: date-time description: The timestamp of resource creation (UTC). lastModifiedByType: type: string description: The type of identity that last modified the resource. enum: - User - Application - ManagedIdentity - Key x-ms-enum: name: createdByType modelAsString: true lastModifiedAt: type: string format: date-time description: The timestamp of resource last modification (UTC) properties: type: object description: Property bag from billing account required: - appId properties: provisioningState: description: Provisioning state. type: string enum: - Succeeded - Failed - Canceled readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true appId: type: string description: Customer owned application ID pattern: (^[A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}?)$ x-ms-mutability: - create - read billingPlanId: type: string description: Billing Plan Id pattern: (^[A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}?)$ readOnly: true AzureHybridBenefitProperties: type: object description: The properties to maximize savings by using Azure Hybrid Benefit properties: scomLicenseType: description: SCOM license type. Maximize savings by using license you already own $ref: '#/definitions/LicenseTypeEnum' windowsServerLicenseType: description: Specifies that the image or disk that is being used was licensed on-premises.

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) $ref: '#/definitions/LicenseTypeEnum' sqlServerLicenseType: description: SQL Server license type. Maximize savings by using Azure Hybrid Benefit for SQL Server with license you already own $ref: '#/definitions/LicenseTypeEnum' OldAgreementTermsList: description: Agreement Terms definition list type: object properties: value: type: array items: $ref: '#/definitions/OldAgreementTerms' TransportAvailabilityRequest: description: Request body to get the transport availability for given sku. type: object properties: skuName: description: Type of the device. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: SkuName modelAsExtensible: true values: - value: DataBox description: Data Box. - value: DataBoxDisk description: Data Box Disk. - value: DataBoxHeavy description: Data Box Heavy. - value: DataBoxCustomerDisk description: Data Box Customer Disk. Attestation: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/AttestationProperties' description: Properties for the attestation. systemData: readOnly: true type: object description: Azure Resource Manager metadata containing createdBy and modifiedBy information. $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData allOf: - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource required: - properties description: An attestation resource. ResourceManagerType: description: Resource manager type. type: string enum: - Default - Admin x-ms-enum: name: ResourceManagerType modelAsString: true AzureSku: type: object required: - name - tier properties: name: description: SKU name. type: string enum: - KC8 - KC16 - KS8 - KS16 - D13_v2 - D14_v2 - L8 - L16 x-ms-enum: name: AzureSkuName modelAsString: true capacity: description: SKU capacity. type: integer tier: description: SKU tier. type: string enum: - Standard x-ms-enum: name: AzureSkuTier modelAsString: true ClusterUpdateVersionParameters: type: object title: ClusterUpdateVersionParameters represents the body of the request to update cluster version. required: - targetClusterVersion properties: targetClusterVersion: description: The version to be applied to the cluster during update. type: string AssessedMachine: type: object x-ms-azure-resource: true description: A machine evaluated as part of an assessment. properties: id: type: string description: Path reference to this assessed machine. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName} readOnly: true name: type: string description: Name of the machine. readOnly: true eTag: type: string description: For optimistic concurrency control. type: type: string description: Type of the object = [Microsoft.Migrate/projects/groups/assessments/assessedMachines]. readOnly: true properties: description: Properties of an assessed machine. x-ms-client-flatten: true $ref: '#/definitions/AssessedMachineProperties' VirtualWanVpnProfileParameters: properties: vpnServerConfigurationResourceId: type: string description: VpnServerConfiguration partial resource uri with which VirtualWan is associated to. authenticationMethod: $ref: ./network.json#/definitions/AuthenticationMethod description: VPN client authentication method. description: Virtual Wan Vpn profile parameters Vpn profile generation. StorageAccount: properties: id: type: string description: The ID of the storage account resource. Video Analyzer relies on tables, queues, and blobs. The primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). identity: $ref: '#/definitions/ResourceIdentity' description: A managed identity that Video Analyzer will use to access the storage account. status: type: string description: The current status of the storage account mapping. readOnly: true type: object required: - id description: The details about the associated storage account. VpnGatewayNatRuleProperties: properties: provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the NAT Rule resource. type: type: string description: The type of NAT rule for VPN NAT. enum: - Static - Dynamic x-ms-enum: name: VpnNatRuleType modelAsString: true mode: type: string description: The Source NAT direction of a VPN NAT. enum: - EgressSnat - IngressSnat x-ms-enum: name: VpnNatRuleMode modelAsString: true internalMappings: type: array items: $ref: '#/definitions/VpnNatRuleMapping' description: The private IP address internal mapping for NAT. externalMappings: type: array items: $ref: '#/definitions/VpnNatRuleMapping' description: The private IP address external mapping for NAT. ipConfigurationId: type: string description: The IP Configuration ID this NAT rule applies to. egressVpnSiteLinkConnections: type: array readOnly: true items: $ref: ./network.json#/definitions/SubResource description: List of egress VpnSiteLinkConnections. ingressVpnSiteLinkConnections: type: array readOnly: true items: $ref: ./network.json#/definitions/SubResource description: List of ingress VpnSiteLinkConnections. description: Parameters for VpnGatewayNatRule. ConfigurationStore: type: object description: An option to store configuration into different place properties: appConfigurationId: x-nullable: true type: string description: The app configuration id to store configuration L3NetworkList: type: object title: L3NetworkList represents a list of L3 networks. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of L3 networks. type: array items: $ref: '#/definitions/L3Network' AvailableSkuRequest: description: The filters for showing the available skus. required: - transferType - country - location type: object properties: transferType: description: Type of the transfer. enum: - ImportToAzure - ExportFromAzure type: string x-ms-enum: name: TransferType modelAsExtensible: true values: - value: ImportToAzure description: Import data to azure. - value: ExportFromAzure description: Export data from azure. country: description: 'ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements' type: string location: description: 'Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01' type: string skuNames: description: Sku Names to filter for available skus type: array items: enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: SkuName modelAsExtensible: true values: - value: DataBox description: Data Box. - value: DataBoxDisk description: Data Box Disk. - value: DataBoxHeavy description: Data Box Heavy. - value: DataBoxCustomerDisk description: Data Box Customer Disk ConfigurationInfo: type: object description: The configuration information, used to generate configurations or save to applications properties: deleteOrUpdateBehavior: description: Indicates whether to clean up previous operation when Linker is updating or deleting $ref: '#/definitions/DeleteOrUpdateBehavior' action: description: Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source. $ref: '#/definitions/ActionType' customizedKeys: description: Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations type: object additionalProperties: type: string daprProperties: description: Indicates some additional properties for dapr client type $ref: '#/definitions/DaprProperties' additionalConfigurations: description: A dictionary of additional configurations to be added. Service will auto generate a set of basic configurations and this property is to full fill more customized configurations type: object additionalProperties: type: string additionalConnectionStringProperties: description: A dictionary of additional properties to be added in the end of connection string. type: object additionalProperties: type: string configurationStore: x-nullable: true description: An option to store configuration into different place $ref: '#/definitions/ConfigurationStore' ContainerExec: type: object description: The container execution command, for liveness or readiness probe properties: command: description: The commands to execute within the container. type: array items: type: string VideoMediaInfo: properties: segmentLength: type: string description: Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. type: object description: Contains information about the video and audio content. logAnalyticsConfiguration: type: object description: Configuration for Log Analytics linking to SCOM managed instance. properties: workspaceId: description: The resource ID of the Log Analytics workspace to be used. type: string dataTypes: description: The types of data to be ingested to Log Analytics workspace. type: array items: type: string enum: - State - Performance - Event - Audit x-ms-enum: name: DataType modelAsString: true importData: description: A one-time optional parameter to import data of last 7 days. default: false type: boolean RouteMap: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/RouteMapProperties' description: Properties of the RouteMap resource. name: type: string readOnly: true description: The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. type: readOnly: true type: string description: Resource type. id: readOnly: true type: string description: Resource id. allOf: - $ref: ./network.json#/definitions/SubResource description: The RouteMap child resource of a Virtual hub. type: object ClusterPoolVersionsListResult: type: object description: Represents a list of cluster pool versions. properties: value: type: array description: The list of cluster pool versions. items: $ref: '#/definitions/ClusterPoolVersion' nextLink: type: string description: The link (url) to the next page of results. readOnly: true AlertRulePatchObject: type: object description: An Activity Log Alert rule object for the body of patch operations. properties: tags: type: object description: The resource tags additionalProperties: type: string properties: x-ms-client-flatten: true $ref: '#/definitions/AlertRulePatchProperties' description: The activity log alert settings for an update operation. ProvisioningState_3: enum: - Succeeded - Failed - Canceled type: string x-ms-enum: name: ProvisioningState modelAsString: true modelAsExtensible: true readOnly: true PolicyReference: description: Resource identifiers for a policy. properties: policyDefinitionId: description: The resource identifier of the policy definition. type: string readOnly: true policySetDefinitionId: description: The resource identifier of the policy set definition. type: string readOnly: true policyDefinitionReferenceId: description: The reference identifier of a specific policy definition within a policy set definition. type: string readOnly: true policyAssignmentId: description: The resource identifier of the policy assignment. type: string readOnly: true metricsResult: description: A metric result. properties: value: $ref: '#/definitions/metricsResultInfo' queryBody: description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) type: object properties: query: description: The query to execute. $ref: '#/definitions/queryParam' timespan: description: Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression. $ref: '#/definitions/queryTimespan' applications: description: A list of Application IDs for cross-application queries. $ref: '#/definitions/applicationsParam' required: - query LogicAppReceiver: description: A logic app receiver. type: object properties: name: type: string description: The name of the logic app receiver. Names must be unique across all receivers within an action group. resourceId: type: string description: The azure resource id of the logic app receiver. callbackUrl: type: string description: The callback url where http request sent to. useCommonAlertSchema: type: boolean default: false description: Indicates whether to use common alert schema. required: - name - resourceId - callbackUrl ActionDetail: description: The action detail type: object properties: MechanismType: type: string description: The mechanism type Name: type: string description: The name of the action Status: type: string description: The status of the action SubState: type: string description: The substatus of the action SendTime: type: string description: The send time Detail: type: string description: The detail of the friendly error message ManagedIdentity: description: Azure Active Directory identity configuration for a resource. type: object properties: type: description: The identity type enum: - None - UserAssigned - SystemAssigned - SystemAssigned,UserAssigned type: string x-ms-enum: name: ManagedIdentityType modelAsString: true principalId: description: System Assigned Identity ObjectId. type: string readOnly: true tenantId: description: The Azure Active Directory tenant id. type: string readOnly: true userAssignedIdentities: description: The resource ids of the user assigned identities to use type: object additionalProperties: $ref: '#/definitions/UserIdentity' FlinkProfile: type: object description: The Flink cluster profile. required: - storage - jobManager - taskManager properties: storage: $ref: '#/definitions/FlinkStorageProfile' numReplicas: type: integer format: int32 description: The number of task managers. jobManager: description: Job Manager container/ process CPU and memory requirements $ref: '#/definitions/ComputeResourceDefinition' historyServer: description: History Server container/ process CPU and memory requirements $ref: '#/definitions/ComputeResourceDefinition' taskManager: description: Task Manager container/ process CPU and memory requirements $ref: '#/definitions/ComputeResourceDefinition' catalogOptions: $ref: '#/definitions/FlinkCatalogOptions' DnsConfiguration: description: DNS configuration for the container group. type: object required: - nameServers properties: nameServers: description: The DNS servers for the container group. type: array items: type: string searchDomains: description: The DNS search domains for hostname lookup in the container group. type: string options: description: The DNS options for the container group. type: string VirtualMachine: type: object title: VirtualMachine represents the on-premises Network Cloud virtual machine. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/VirtualMachineProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true ClusterManager: type: object title: ClusterManager represents a control-plane to manage one or more on-premises clusters. required: - properties properties: properties: $ref: '#/definitions/ClusterManagerProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true TrinoWorker: type: object description: Trino worker. properties: debug: $ref: '#/definitions/TrinoDebugConfig' x-ms-client-flatten: true CloudError_4: description: Provides additional information about an http error response. properties: additionalInfo: description: Gets or sets additional error info. items: $ref: '#/definitions/AdditionalErrorInfo' readOnly: true type: array code: description: Error code. type: string details: description: Gets or sets details for the error. items: $ref: '#/definitions/CloudError_4' readOnly: true type: array message: description: The error message parsed from the body of the http error response. type: string target: description: Gets or sets the target of the error. type: string type: object TrinoUserTelemetry: type: object description: User telemetry properties: storage: $ref: '#/definitions/TrinoTelemetryConfig' AzureDevOpsRepoListResponse: type: object properties: value: description: Gets or sets list of resources. type: array items: $ref: '#/definitions/AzureDevOpsRepo' x-ms-identifiers: [] nextLink: description: Gets or sets next link to scroll over the results. type: string PeerRouteList: type: object additionalProperties: type: array items: $ref: '#/definitions/PeerRoute' x-ms-identifiers: [] description: List of peer routes. description: Map from virtual router instance to list of peer routes. HubIpConfiguration: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/HubIPConfigurationPropertiesFormat' description: The properties of the Virtual Hub IPConfigurations. name: type: string description: Name of the Ip Configuration. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. type: type: string readOnly: true description: Ipconfiguration type. allOf: - $ref: ./network.json#/definitions/SubResource description: IpConfigurations. CloudError_10: x-ms-external: true properties: error: $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: An error response for a resource management request. PrivateLinkServiceConnectionState: type: object description: Private endpoint connection state. properties: status: enum: - Approved - Pending - Rejected - Disconnected type: string description: Private link connection state. x-ms-enum: name: PrivateLinkServiceConnectionState_status modelAsString: true description: type: string description: Description of the object. actionsRequired: type: string description: Action required. CredentialResults: type: object properties: hybridConnectionConfig: $ref: '#/definitions/HybridConnectionConfig' description: Contains the REP (rendezvous endpoint) and “Sender” access token. readOnly: true kubeconfigs: type: array readOnly: true items: $ref: '#/definitions/CredentialResult' x-ms-identifiers: - name description: Base64-encoded Kubernetes configuration file. description: The list of credential result response. DocumentProcessorPatchableProperties: type: object description: Document processor properties that can be updated properties: tags: type: object description: Resource tags. additionalProperties: type: string properties: type: object x-ms-client-flatten: true description: Syntex properties for PATCH. properties: spoTenantUrl: type: string description: The URL of an SharePoint Online (SPO) tenant associated with this document processor resource spoTenantId: type: string description: The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource CheckNameAvailabilityRequestBody: description: The request body for a request to to check availability of a bot name. type: object properties: name: description: the name of the bot for which availability needs to be checked. type: string type: description: the type of the bot for which availability needs to be checked type: string required: - name - type OAuth2PermissionGrantDefinition: description: Application permission grant definition. type: object properties: resource: description: The resource identifier. This should be the application identifier of the resource application. type: string client: description: The client identifier. This should be the application identifier of the client application. type: string scope: description: The scope identifier. This should be the scope value of the OAUTH2PERMISSION exposed by the resource application. type: string NetworkRuleSet: properties: ipRules: type: array description: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. items: $ref: '#/definitions/IpRule' bypass: type: string enum: - None - AzurePortal x-ms-enum: name: SearchBypass modelAsString: true values: - value: None name: None description: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. - value: AzurePortal name: AzurePortal description: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. description: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. description: Network specific rules that determine how the Azure Cognitive Search service may be reached. CloudErrorBody_9: type: object description: Describes a particular API error with an error code and a message. properties: code: type: string description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. message: type: string description: A message that describes the error in detail and provides debugging information. 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_9' description: Contains nested errors that are related to this error. x-ms-external: true AseRegionCollection: description: Collection of ASE regions. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/AseRegion' nextLink: description: Link to next page of resources. type: string readOnly: true TrackSelection: properties: trackSelections: type: array items: $ref: '#/definitions/TrackPropertyCondition' description: TrackSelections is a track property condition list which can specify track(s) type: object description: Class to select a track schema: type: object description: The schema object. properties: id: type: string description: ID associated with this schema connectionId: type: string description: Connection ID associated with this schema status: enum: - New - Approved type: string x-ms-enum: name: schemaStatus modelAsString: true description: Status of the schema name: type: string description: Name of the schema content: type: string description: Content of the schema TagsResource_2: properties: tags: additionalProperties: type: string description: Resource tags description: A container holding only the Tags for a resource, allowing the user to update the tags on a QueryPack instance. WebhookReceiver: description: A webhook receiver. type: object properties: name: type: string description: The name of the webhook receiver. Names must be unique across all receivers within an action group. serviceUri: type: string description: The URI where webhooks should be sent. useCommonAlertSchema: type: boolean default: false description: Indicates whether to use common alert schema. useAadAuth: type: boolean default: false description: Indicates whether or not use AAD authentication. objectId: type: string description: Indicates the webhook app object Id for aad auth. identifierUri: type: string description: Indicates the identifier uri for aad auth. tenantId: type: string description: Indicates the tenant id for aad auth. required: - name - serviceUri schemas: type: array description: The schemas for this connection x-ms-identifiers: - connectionId - name items: $ref: '#/definitions/schema' BareMetalMachinePatchParameters: type: object title: BareMetalMachinePatchParameters represents the body of the request to patch bare metal machine properties. properties: properties: $ref: '#/definitions/BareMetalMachinePatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string IdentityHealthCheckReportDefinition: description: The identity health check report action definition. type: object properties: reportStartTimeUtc: description: Start time of the report. type: string format: date-time reportEndTimeUtc: description: End time of the report. type: string format: date-time status: description: The roll-up health status for the directory. $ref: '#/definitions/HealthStatus' directoryTenants: description: List of directory tenant health reports. $ref: '#/definitions/DirectoryTenantHealthReportList' BgpAdvertisement: type: object title: BgpAdvertisement represents the association of IP address pools to the communities and peers. required: - ipAddressPools properties: advertiseToFabric: description: The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False. type: string default: 'True' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: AdvertiseToFabric x-ms-mutability: - read - create communities: description: The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format. type: array items: type: string x-ms-mutability: - read - create ipAddressPools: description: The names of the IP address pools associated with this announcement. type: array items: type: string x-ms-mutability: - read - create peers: description: The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement. type: array items: type: string x-ms-mutability: - read - create HostingEnvironmentDeploymentInfo: description: Information needed to create resources on an App Service Environment. type: object properties: name: description: Name of the App Service Environment. type: string location: description: Location of the App Service Environment. type: string ManagedCassandraReaperStatus: type: object properties: healthy: type: boolean repairRunIds: type: object additionalProperties: type: string repairSchedules: type: object additionalProperties: type: string P2SConnectionConfigurationProperties: properties: vpnClientAddressPool: $ref: ./virtualNetwork.json#/definitions/AddressSpace description: The reference to the address space resource which represents Address space for P2S VpnClient. routingConfiguration: $ref: '#/definitions/RoutingConfiguration' description: The Routing Configuration indicating the associated and propagated route tables on this connection. enableInternetSecurity: type: boolean description: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. configurationPolicyGroupAssociations: type: array readOnly: true items: $ref: ./network.json#/definitions/SubResource description: List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to. previousConfigurationPolicyGroupAssociations: type: array readOnly: true items: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' description: List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the P2SConnectionConfiguration resource. description: Parameters for P2SConnectionConfiguration. ActionableRemediationState: description: "ActionableRemediation Setting.\r\nNone - the setting was never set.\r\nEnabled - ActionableRemediation is enabled.\r\nDisabled - ActionableRemediation is disabled." enum: - None - Disabled - Enabled type: string x-ms-enum: name: ActionableRemediationState modelAsString: true modelAsExtensible: true HardwareValidationStatus: type: object title: HardwareValidationStatus represents the latest hardware validation details performed for this bare metal machine. properties: lastValidationTime: description: The timestamp of the hardware validation execution. type: string format: date-time readOnly: true result: description: The outcome of the hardware validation. type: string enum: - Pass - Fail x-ms-enum: modelAsString: true name: BareMetalMachineHardwareValidationResult readOnly: true BmcKeySetList: type: object title: BmcKeySetList represents a list of baseboard management controller key sets. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of baseboard management controller key sets. type: array items: $ref: '#/definitions/BmcKeySet' Azure.Core.Foundations.Error: type: object description: The error object. properties: code: type: string description: One of a server-defined set of error codes. message: type: string description: A human-readable representation of the error. target: type: string description: The target of the error. details: type: array description: An array of details about specific errors that led to this reported error. items: $ref: '#/definitions/Azure.Core.Foundations.Error' x-ms-identifiers: [] innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: An object containing more specific information than the current object about the error. required: - code - message CheckRestrictionsRequest: description: The check policy restrictions parameters describing the resource that is being evaluated. properties: resourceDetails: description: The information about the resource that will be evaluated. $ref: '#/definitions/CheckRestrictionsResourceDetails' pendingFields: description: The list of fields and values that should be evaluated for potential restrictions. type: array items: $ref: '#/definitions/PendingField' required: - resourceDetails SessionDetails: type: object description: Session, a logical grouping of jobs. properties: id: $ref: '#/definitions/WorkspaceItemId' description: Id of the session. readOnly: true jobFailurePolicy: $ref: '#/definitions/SessionJobFailurePolicy' description: Policy controlling the behavior of the Session when a job in the session fails. x-ms-mutability: - read - create status: $ref: '#/definitions/SessionStatus' description: The status of the session. readOnly: true required: - id - jobFailurePolicy allOf: - $ref: '#/definitions/ItemDetails' x-ms-discriminator-value: Session WorkspaceItemId: type: string description: Id of the workspace item. maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ connection: type: object x-ms-azure-resource: true properties: properties: $ref: '#/definitions/connectionProperties' required: - location allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource description: The connection resource definition. ClusterJobProperties: description: Properties of cluster job. type: object properties: jobType: description: Type of cluster job. enum: - FlinkJob type: string x-ms-enum: name: jobType modelAsString: true discriminator: jobType required: - jobType PrivateEndpointConnection: type: object properties: properties: $ref: '#/definitions/PrivateEndpointConnectionProperties' x-ms-client-flatten: true description: Resource properties. etag: type: string description: Modified whenever there is a change in the state of private endpoint connection. allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource description: The private endpoint connection resource. x-ms-azure-resource: true KeySetUser: type: object title: KeySetUser represents the properties of the user in the key set. required: - azureUserName - sshPublicKey properties: azureUserName: description: The user name that will be used for access. type: string description: description: The free-form description for this user. type: string maxLength: 256 sshPublicKey: $ref: '#/definitions/SshPublicKey' description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. userPrincipalName: description: The user principal name (email format) used to validate this user's group membership. type: string QuantumWorkspace: type: object description: The resource proxy definition object for quantum workspace. properties: properties: x-ms-client-flatten: true description: Gets or sets the properties. Define quantum workspace's specific properties. $ref: '#/definitions/WorkspaceResourceProperties' identity: type: object description: Managed Identity information. properties: principalId: readOnly: true type: string description: The principal ID of resource identity. tenantId: readOnly: true type: string description: The tenant ID of resource. type: type: string description: The identity type. enum: - SystemAssigned - None x-ms-enum: name: ResourceIdentityType modelAsString: true systemData: description: System metadata $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData readOnly: true allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource Quota: type: object description: Quota information. properties: dimension: type: string description: The name of the dimension associated with the quota. readOnly: true scope: $ref: '#/definitions/DimensionScope' description: The scope at which the quota is applied. readOnly: true providerId: type: string description: The unique identifier for the provider. readOnly: true utilization: type: number format: float description: The amount of the usage that has been applied for the current period. readOnly: true holds: type: number format: float description: The amount of the usage that has been reserved but not applied for the current period. readOnly: true limit: type: number format: float description: The maximum amount of usage allowed for the current period. readOnly: true period: $ref: '#/definitions/MeterPeriod' description: The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas. readOnly: true required: - dimension - scope - providerId - utilization - holds - limit - period AzureResource_2: description: An Azure resource object. x-ms-azure-resource: true type: object properties: id: description: The resource Id. type: string readOnly: true name: description: The name of the resource. type: string readOnly: true type: description: The type of the resource. type: string readOnly: true location: description: The location of the resource. Azure Activity Log Alert rules are supported on Global, West Europe and North Europe regions. type: string default: global x-ms-mutability: - read - create tags: description: The tags of the resource. type: object additionalProperties: type: string FlinkStorageProfile: type: object description: The storage profile required: - storageUri properties: storageUri: type: string pattern: ^(\w{4,5})://(.*)@(.*).\b(blob|dfs)\b\.core\.windows\.net$ description: Storage account uri which is used for savepoint and checkpoint state. storagekey: type: string description: Storage key is only required for wasb(s) storage. x-ms-secret: true GraphQueryPropertiesUpdateParameters: description: Properties that contain a workbook for PATCH operation. properties: description: type: string description: The description of a graph query. query: type: string description: KQL query that will be graph. ClusterPatch: type: object description: The patch for a cluster. properties: properties: x-ms-client-flatten: true description: Define cluster patch specific properties. $ref: '#/definitions/ClusterPatchProperties' allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource CatalogOptions: type: object description: Trino cluster catalog options. properties: hive: type: array description: hive catalog options. items: $ref: '#/definitions/HiveCatalogOption' x-ms-identifiers: [] MeterPeriod: type: string description: The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas. enum: - None - Monthly x-ms-enum: name: MeterPeriod modelAsString: true values: - name: None value: None description: The meter period is instantaneous. Used for concurrent quotas. - name: Monthly value: Monthly description: The meter period is per month. ResourceIdentityType: description: The type of identity used for the resource mover service. enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: name: ResourceIdentityType modelAsString: true ConnectedClusterProperties: type: object required: - agentPublicKeyCertificate properties: agentPublicKeyCertificate: type: string description: Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure. kubernetesVersion: readOnly: true type: string description: The Kubernetes version of the connected cluster resource totalNodeCount: readOnly: true type: integer description: Number of nodes present in the connected cluster resource totalCoreCount: readOnly: true format: int32 type: integer description: Number of CPU cores present in the connected cluster resource agentVersion: readOnly: true type: string description: Version of the agent running on the connected cluster resource provisioningState: $ref: '#/definitions/ConnectedClusterProvisioningState' description: Provisioning state of the connected cluster resource. distribution: type: string description: The Kubernetes distribution running on this connected cluster. distributionVersion: type: string description: The Kubernetes distribution version on this connected cluster. infrastructure: type: string description: The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. offering: type: string readOnly: true description: Connected cluster offering managedIdentityCertificateExpirationTime: type: string format: date-time readOnly: true description: Expiration time of the managed identity certificate lastConnectivityTime: type: string readOnly: true format: date-time description: Time representing the last instance when heart beat was received from the cluster connectivityStatus: type: string readOnly: true description: Represents the connectivity status of the connected cluster. enum: - Connecting - Connected - Offline - Expired x-ms-enum: name: ConnectivityStatus modelAsString: true privateLinkState: type: string description: Property which describes the state of private link on a connected cluster resource. default: Disabled enum: - Enabled - Disabled x-ms-enum: name: PrivateLinkState modelAsString: true privateLinkScopeResourceId: type: string description: The resource id of the private link scope this connected cluster is assigned to, if any. azureHybridBenefit: type: string description: Indicates whether Azure Hybrid Benefit is opted in enum: - 'True' - 'False' - NotApplicable default: NotApplicable x-ms-enum: name: AzureHybridBenefit modelAsString: true aadProfile: description: AAD profile for the connected cluster. $ref: '#/definitions/AadProfile' arcAgentProfile: description: Arc agentry configuration for the provisioned cluster. $ref: '#/definitions/ArcAgentProfile' miscellaneousProperties: description: More properties related to the Connected Cluster type: object additionalProperties: type: string readOnly: true description: Properties of the connected cluster. queryResults: title: A query response. description: Contains the tables, columns & rows resulting from a query. type: object properties: tables: description: The list of tables, columns and rows. type: array items: $ref: '#/definitions/table' required: - tables ManagedResourceGroupConfiguration: type: object title: ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure. properties: location: description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. type: string x-ms-mutability: - read - create name: description: The name for the managed resource group. If not specified, the unique name is automatically generated. type: string maxLength: 75 x-ms-mutability: - read - create PrivateEndpointConnectionProperties: type: object properties: privateEndpoint: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpoint description: The private endpoint resource. privateLinkServiceConnectionState: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkServiceConnectionState description: A collection of information about the state of the connection between service consumer and provider. provisioningState: $ref: '#/definitions/PrivateEndpointConnectionProvisioningState' description: The provisioning state of the private endpoint connection resource. groupIds: description: The group ids for the private endpoint resource. type: array items: type: string readOnly: true required: - privateLinkServiceConnectionState description: Properties of the private endpoint connection. PreferredRoutingGateway: type: string description: The preferred routing gateway types enum: - ExpressRoute - VpnGateway - None x-ms-enum: name: PreferredRoutingGateway modelAsString: true Remediation: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/RemediationProperties' description: Properties for the remediation. id: type: string description: The ID of the remediation. readOnly: true type: type: string description: The type of the remediation. readOnly: true name: type: string description: The name of the remediation. readOnly: true description: The remediation definition. x-ms-azure-resource: true PerimeterAssociableResource: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/PerimeterAssociableResourceProperties' description: Properties of the perimeter associable resource. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. id: readOnly: true type: string description: Identifier of the perimeter associable resource. type: readOnly: true type: string description: Resource type. allOf: - $ref: ./network.json#/definitions/Resource description: Resource that is onboarded to use network security perimeter. Also referred as perimeter associable resource. Container: description: A container instance. type: object required: - properties - name properties: name: description: The user-provided name of the container instance. type: string properties: x-ms-client-flatten: true description: The properties of the container instance. $ref: '#/definitions/ContainerProperties' KubernetesCluster: type: object title: KubernetesCluster represents the Kubernetes cluster hosted on Network Cloud. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/KubernetesClusterProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true ThroughputPoolAccountsListResult: description: The List operation response, that contains the global database accounts and their properties. type: object properties: value: readOnly: true type: array items: $ref: '#/definitions/ThroughputPoolAccountResource' description: List of global database accounts in a throughput pool and their properties. nextLink: description: The link used to get the next page of results. type: string readOnly: true GraphQueryProperties: description: Properties that contain a graph query. required: - query properties: timeModified: type: string description: Date and time in UTC of the last modification that was made to this graph query definition. format: date-time readOnly: true description: type: string description: The description of a graph query. query: type: string description: KQL query that will be graph. resultKind: description: Enum indicating a type of graph query. readOnly: true type: string enum: - basic x-ms-enum: name: ResultKind modelAsString: true HealthMonitorList: title: Information about the current health statuses of the monitors. type: object readOnly: true properties: value: description: Array of health monitors of the virtual machine. type: array items: $ref: '#/definitions/HealthMonitor' nextLink: description: Link to next page if the list is too long. type: string LicenseTypeEnum: description: The license type associated with different SCOM infrastructure components. type: string enum: - None - AzureHybridBenefit x-ms-enum: name: hybridLicenseType modelAsString: true VideoPreviewImageUrls: properties: small: type: string description: Low resolution preview image URL. medium: type: string description: Medium resolution preview image URL. large: type: string description: High resolution preview image URL. type: object description: Video preview image URLs. These URLs can be used in conjunction with the video content authorization token to download the most recent still image from the video archive in different resolutions. They are available when the video type is 'archive' and preview images are enabled. metadataTable: title: A data table that takes part in a schema of an Application Insights app. description: Tables are part of the app schema, and contain a list of columns and a reference to other relevant metadata items. type: object properties: id: description: The ID of the table type: string name: description: The name of the table type: string description: description: The description of the table type: string timespanColumn: description: The column associated with the timespan query parameter for the table type: string columns: description: The list of columns defined on the table type: array items: properties: name: description: The name of the column type: string description: description: The description of the column type: string type: description: The data type of the column type: string enum: - bool - datetime - dynamic - int - long - real - string x-ms-enum: name: MetadataColumnDataType modelAsString: true isPreferredFacet: description: A flag indicating this column is a preferred facet type: boolean source: description: an indication of the source of the column, used only when multiple apps have conflicting definition for the column type: object required: - name - type required: - id - name ItemType: type: string description: The type of the workspace item. enum: - Job - Session x-ms-enum: name: ItemType modelAsString: true values: - name: Job value: Job description: A program, problem, or application submitted for processing. - name: Session value: Session description: A logical grouping of jobs. RackSku: type: object title: RackSku represents the SKU information of the rack. required: - properties properties: properties: $ref: '#/definitions/RackSkuProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/Resource x-ms-azure-resource: true SecretsProfile: type: object description: The cluster secret profile. required: - keyVaultResourceId properties: keyVaultResourceId: type: string description: Name of the user Key Vault where all the cluster specific user secrets are stored. format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.KeyVault/vaults secrets: type: array description: Properties of Key Vault secret. items: $ref: '#/definitions/SecretReference' x-ms-identifiers: [] PolicyAssignmentSummary: description: Policy assignment summary. properties: policyAssignmentId: description: Policy assignment ID. type: string policySetDefinitionId: description: Policy set definition ID, if the policy assignment is for a policy set. type: string results: description: Non-compliance summary for the policy assignment. $ref: '#/definitions/SummaryResults' policyDefinitions: description: Policy definitions summary. type: array items: $ref: '#/definitions/PolicyDefinitionSummary' CheckNameAvailabilityOutput: description: The response body for CheckNameAvailability API. properties: nameAvailable: description: Specifies if the name is available. type: boolean reason: description: Specifies the reason if the name is not available. type: string enum: - None - Invalid - AlreadyExists x-ms-enum: name: EntityNameUnavailabilityReason modelAsString: false message: description: Specifies the detailed reason if the name is not available. type: string EnableStatus: type: string description: Enable status enum: - Enabled - Disabled x-ms-enum: name: EnableStatus modelAsString: true ActionGroup_2: type: object description: A pointer to an Azure Action Group. properties: actionGroupId: description: The resource ID of the Action Group. This cannot be null or empty. type: string webhookProperties: type: object description: the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. additionalProperties: type: string actionProperties: type: object additionalProperties: type: string description: Predefined list of properties and configuration items for the action group. required: - actionGroupId SearchService: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/SearchServiceProperties' description: Properties of the search service. sku: $ref: '#/definitions/Sku_4' description: The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. externalDocs: url: https://azure.microsoft.com/documentation/articles/search-sku-tier/ identity: $ref: '#/definitions/Identity_4' description: The identity of the resource. allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource description: Describes an Azure Cognitive Search service and its current state. ComparisonRule: type: object description: The comparison rule. required: - operator - threshold properties: operator: type: string description: The comparison operator. enum: - greaterThan - greaterThanOrEqual - lessThan - lessThanOrEqual x-ms-enum: name: ComparisonOperator modelAsString: true threshold: type: number description: Threshold setting. DeploymentLocations: description: 'List of available locations (regions or App Service Environments) for deployment of App Service resources.' type: object properties: locations: description: Available regions. type: array items: $ref: '#/definitions/GeoRegion' hostingEnvironments: description: Available App Service Environments with full descriptions of the environments. type: array items: $ref: ./CommonDefinitions.json#/definitions/AppServiceEnvironment x-ms-identifiers: [] hostingEnvironmentDeploymentInfos: description: Available App Service Environments with basic information. type: array items: $ref: '#/definitions/HostingEnvironmentDeploymentInfo' x-ms-identifiers: - name ServicePrincipalTagHealthReportList: description: List of ServicePrincipalTag health reports for the application. properties: value: type: array description: A report of the health status of a tag on an identity application service principal. items: $ref: '#/definitions/ServicePrincipalTagHealthReport' x-ms-identifiers: - servicePrincipalTag nextLink: description: URI to the next page. type: string HttpHeader: description: The HTTP header. type: object properties: name: type: string description: The header name. value: type: string description: The header value. ServiceConfigListResultProperties: type: object properties: serviceName: type: string description: Service Config Name. fileName: type: string description: File Name. content: type: string description: Content in the service config file. componentName: type: string description: Component Name. type: type: string description: Config type. path: type: string description: Config file path. customKeys: type: object description: The custom keys. additionalProperties: type: string defaultKeys: type: object description: The default keys. additionalProperties: $ref: '#/definitions/ServiceConfigListResultValueEntity' required: - serviceName - componentName - fileName description: Service config response. cachedImages: description: The cached image and OS type. type: object required: - osType - image properties: osType: type: string description: The OS type of the cached image. image: type: string description: The cached image name. Identity: type: object properties: principalId: readOnly: true type: string description: The principal ID of resource identity. This property will only be provided for a system assigned identity. tenantId: readOnly: true type: string description: The tenant ID of resource. This property will only be provided for a system assigned identity. type: type: string description: The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot enum: - SystemAssigned - UserAssigned - SystemAssigned, UserAssigned - None x-ms-enum: name: ResourceIdentityType modelAsString: false userAssignedIdentities: $ref: '#/definitions/UserAssignedIdentityMap' description: 'The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''. ' description: Identity for the resource. VirtualWanSecurityProvider: properties: name: type: string description: Name of the security provider. url: type: string description: Url of the security provider. type: $ref: '#/definitions/VirtualWanSecurityProviderType' description: Name of the security provider. description: Collection of SecurityProviders. Nic: type: object title: Type Deprecated. Will be removed in an upcoming version. Nic represents the network interface card details. properties: lldpNeighbor: $ref: '#/definitions/LldpNeighbor' description: The information about the device connected to this NIC. readOnly: true macAddress: description: The MAC address associated with this NIC. type: string readOnly: true name: description: The name of the NIC/interface. type: string readOnly: true ScheduleAvailabilityResponse: description: Schedule availability for given sku in a region. type: object properties: availableDates: description: List of dates available to schedule type: array items: format: date-time type: string readOnly: true UpdateStateProperties: description: Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property. type: object properties: progressPercentage: description: Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded. type: number notifyMessage: description: Brief message with instructions for updates of AvailabilityType Notify. type: string ErrorResponse_10: title: Error response type: object properties: error: description: Error info. type: object properties: code: description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. type: string message: description: Human-readable representation of the error. type: string details: description: Error details. type: array items: $ref: '#/definitions/ErrorDetails' x-ms-identifiers: [] AppRoleAssignmentDefinition: description: Application role assignment definition. type: object properties: resource: description: The resource identifier. This should be the application identifier of the resource application. type: string client: description: The client identifier. This should be the application identifier of the client application. type: string roleId: description: The role identifier. This should be the ID of the AppRole exposed by the resource application. type: string DataLocationToServiceLocationMap: description: Map of data location to service location type: object properties: dataLocation: description: Location of the data. type: string readOnly: true serviceLocation: description: Location of the service. type: string readOnly: true ComponentPurgeBody: description: Describes the body of a purge request for an App Insights component required: - table - filters properties: table: type: string description: Table from which to purge data. filters: type: array description: The set of columns and filters (queries) to run over them to purge the resulting data. items: $ref: '#/definitions/ComponentPurgeBodyFilters' AzureFileVolume: description: The properties of the Azure File volume. Azure File shares are mounted as volumes. type: object required: - shareName - storageAccountName properties: shareName: description: The name of the Azure File share to be mounted as a volume. type: string readOnly: description: The flag indicating whether the Azure File shared mounted as a volume is read-only. type: boolean storageAccountName: description: The name of the storage account that contains the Azure File share. type: string storageAccountKey: description: The storage account access key used to access the Azure File share. type: string ErrorResponse_7: description: Describes the format of Error response. type: object properties: code: description: Error code type: string message: description: Error message indicating why the operation failed. type: string ContainerHttpGet: type: object description: The container Http Get settings, for liveness or readiness probe properties: path: description: The path to probe. type: string port: type: integer description: The port number to probe. format: int32 scheme: description: The scheme. type: string enum: - http - https x-ms-enum: name: Scheme modelAsString: true httpHeaders: description: The HTTP headers. type: array items: $ref: '#/definitions/HttpHeader' x-ms-identifiers: - name required: - port StorageAccount_2: description: The properties of a storage account associated with this resource. example: id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia isPrimary: true required: - id - isPrimary properties: id: description: The id of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts (isPrimary false). type: string isPrimary: description: Is this storage account resource the primary storage account for the Media Service resource. Blob only storage must set this to false. type: boolean VpnServerConfigurationPolicyGroupMember: properties: name: type: string description: Name of the VpnServerConfigurationPolicyGroupMember. attributeType: type: string description: The Vpn Policy member attribute type. enum: - CertificateGroupId - AADGroupId - RadiusAzureGroupId x-ms-enum: name: VpnPolicyMemberAttributeType modelAsString: true attributeValue: type: string description: The value of Attribute used for this VpnServerConfigurationPolicyGroupMember. description: VpnServerConfiguration PolicyGroup member type: object ManagedInstanceOperationStatus: description: Gets status of current and latest SCOM managed instance operation. type: object properties: operationName: description: Operation Name type: string readOnly: true operationState: description: Operation status type: string readOnly: true id: description: Operation id type: string readOnly: true Sku_2: description: The Sku. required: - name type: object properties: name: description: The sku name. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: SkuName modelAsExtensible: true values: - value: DataBox description: Data Box. - value: DataBoxDisk description: Data Box Disk. - value: DataBoxHeavy description: Data Box Heavy. - value: DataBoxCustomerDisk description: Data Box Customer Disk. displayName: description: The display name of the sku. type: string family: description: The sku family. type: string model: description: The display name of the sku. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk - DataBoxV2x100 - DataBoxV2x500 type: string x-ms-enum: name: ModelNames modelAsExtensible: true values: - value: DataBox description: Data Box. - value: DataBoxDisk description: Data Box Disk. - value: DataBoxHeavy description: Data Box Heavy. - value: DataBoxCustomerDisk description: Data Box Customer Disk - value: DataBoxV2x100 description: Data Box V2 100TB. - value: DataBoxV2x500 description: Data Box V2 500TB. EndpointProperties: description: Describes a container endpoint. type: object properties: name: description: The name of the endpoint. type: string port: description: Port used by the container. type: integer required: - name ArmRoleReceiver: description: An arm role receiver. type: object properties: name: type: string description: The name of the arm role receiver. Names must be unique across all receivers within an action group. roleId: type: string description: The arm role id. useCommonAlertSchema: type: boolean default: false description: Indicates whether to use common alert schema. required: - name - roleId ClusterInstanceViewsResult: type: object properties: value: items: $ref: '#/definitions/ClusterInstanceViewResult' type: array description: Cluster instance view array. x-ms-identifiers: [] nextLink: description: The link (url) to the next page of results. type: string readOnly: true description: The instance view of a HDInsight Cluster. VoiceReceiver: description: A voice receiver. type: object properties: name: type: string description: The name of the voice receiver. Names must be unique across all receivers within an action group. countryCode: type: string description: The country code of the voice receiver. phoneNumber: type: string description: The phone number of the voice receiver. required: - name - countryCode - phoneNumber SparkUserPlugin: type: object description: Spark user plugin. required: - path properties: path: type: string description: Fully qualified path to the folder containing the plugins. minLength: 1 pattern: ^(https)|(abfss)://.*$ AzureResource_3: description: Describes an Azure resource that is attached to an identity. type: object title: Azure Resource properties. properties: id: type: string readOnly: true description: The ID of this resource. name: type: string readOnly: true description: The name of this resource. type: type: string readOnly: true description: The type of this resource. resourceGroup: type: string readOnly: true description: The name of the resource group this resource belongs to. subscriptionId: type: string readOnly: true description: The ID of the subscription this resource belongs to. subscriptionDisplayName: type: string readOnly: true description: The name of the subscription this resource belongs to. ServiceList: description: 'A pageable list of all services in an application. ' type: object properties: value: type: array items: $ref: '#/definitions/ServiceResourceDescription' description: One page of the list. nextLink: type: string description: URI to fetch the next page of the list. NameAvailabilityParameters: description: Details of check name availability request body. type: object properties: name: type: string description: Name for checking availability. type: type: string description: The resource type in Microsoft.HDInsight. TrunkedNetworkAttachmentConfiguration: type: object title: TrunkedNetworkAttachmentConfiguration represents the configuration of the attachment of a trunked network. required: - networkId properties: networkId: description: The resource ID of the network that is being configured for attachment. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.NetworkCloud/trunkedNetworks x-ms-mutability: - read - create pluginType: description: The indicator of how this network will be utilized by the Kubernetes cluster. type: string default: SRIOV enum: - DPDK - SRIOV - OSDevice - MACVLAN - IPVLAN x-ms-enum: modelAsString: true name: KubernetesPluginType x-ms-mutability: - read - create HubRoutingPreference: type: string description: The hub routing preference gateway types enum: - ExpressRoute - VpnGateway - ASPath x-ms-enum: name: HubRoutingPreference modelAsString: true ServiceCollection: type: object properties: value: type: array items: $ref: '#/definitions/Service' x-typespec-name: Service[] description: The Service items on this page nextLink: type: string format: uri description: The link to the next page of items x-typespec-name: Rest.ResourceLocation description: The response of a Service list operation. required: - value StorageAppliance: type: object title: StorageAppliance represents on-premises Network Cloud storage appliance. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/StorageApplianceProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true ValidationInputRequest: description: Minimum fields that must be present in any type of validation request. required: - validationType type: object properties: validationType: description: Identifies the type of validation request. enum: - ValidateAddress - ValidateSubscriptionIsAllowedToCreateJob - ValidatePreferences - ValidateCreateOrderLimit - ValidateSkuAvailability - ValidateDataTransferDetails type: string x-ms-enum: name: ValidationInputDiscriminator modelAsExtensible: true values: - value: ValidateAddress description: Identify request and response of address validation. - value: ValidateSubscriptionIsAllowedToCreateJob description: Identify request and response for validation of subscription permission to create job. - value: ValidatePreferences description: Identify request and response of preference validation. - value: ValidateCreateOrderLimit description: Identify request and response of create order limit for subscription validation. - value: ValidateSkuAvailability description: Identify request and response of active job limit for sku availability. - value: ValidateDataTransferDetails description: Identify request and response of data transfer details validation. discriminator: validationType L3NetworkProperties: type: object title: L3NetworkProperties represents properties of the L3 network. required: - l3IsolationDomainId - vlan properties: associatedResourceIds: description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. type: array items: type: string readOnly: true clusterId: description: The resource ID of the Network Cloud cluster this L3 network is associated with. type: string format: arm-id readOnly: true detailedStatus: description: The more detailed status of the L3 network. type: string enum: - Error - Available - Provisioning x-ms-enum: modelAsString: true name: L3NetworkDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true hybridAksClustersAssociatedIds: description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network. type: array items: type: string readOnly: true hybridAksIpamEnabled: description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. type: string default: 'True' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: HybridAksIpamEnabled x-ms-mutability: - read - create hybridAksPluginType: description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS. type: string default: SRIOV enum: - DPDK - SRIOV - OSDevice x-ms-enum: modelAsString: true name: HybridAksPluginType x-ms-mutability: - read - create interfaceName: description: The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. type: string maxLength: 12 pattern: ^[a-zA-Z0-9@._-]*$ x-ms-mutability: - read - create ipAllocationType: description: The type of the IP address allocation, defaulted to "DualStack". type: string default: DualStack enum: - IPV4 - IPV6 - DualStack x-ms-enum: modelAsString: true name: IpAllocationType ipv4ConnectedPrefix: description: 'The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack.' type: string x-ms-mutability: - read - create ipv6ConnectedPrefix: description: 'The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack.' type: string x-ms-mutability: - read - create l3IsolationDomainId: description: The resource ID of the Network Fabric l3IsolationDomain. type: string format: arm-id x-ms-mutability: - read - create provisioningState: description: The provisioning state of the L3 network. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted x-ms-enum: modelAsString: true name: L3NetworkProvisioningState readOnly: true virtualMachinesAssociatedIds: description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network. type: array items: type: string readOnly: true vlan: description: The VLAN from the l3IsolationDomain that is used for this network. type: integer format: int64 x-ms-mutability: - read - create RackSkuProperties: type: object title: RackSkuProperties represents the properties of compute-related hardware for a rack. This supports both aggregator and compute racks. properties: computeMachines: description: The list of machine SKUs and associated rack slot for the compute-dedicated machines in this rack model. type: array items: $ref: '#/definitions/MachineSkuSlot' x-ms-identifiers: [] readOnly: true controllerMachines: description: The list of machine SKUs and associated rack slot for the control-plane dedicated machines in this rack model. type: array items: $ref: '#/definitions/MachineSkuSlot' x-ms-identifiers: [] readOnly: true description: description: The free-form text describing the rack. type: string readOnly: true maxClusterSlots: description: The maximum number of compute racks supported by an aggregator rack. 0 if this is a compute rack or a rack for a single rack cluster(rackType="Single"). type: integer format: int64 readOnly: true provisioningState: description: The provisioning state of the rack SKU resource. type: string enum: - Succeeded x-ms-enum: modelAsString: true name: RackSkuProvisioningState readOnly: true rackType: description: The type of the rack. type: string enum: - Aggregator - Compute - Single x-ms-enum: modelAsString: true name: RackSkuType readOnly: true storageAppliances: description: The list of appliance SKUs and associated rack slot for the storage appliance(s) in this rack model. type: array items: $ref: '#/definitions/StorageApplianceSkuSlot' x-ms-identifiers: [] readOnly: true supportedRackSkuIds: description: The list of supported SKUs if the rack is an aggregator. type: array items: type: string readOnly: true StreamingLocatorContentKey: properties: id: type: string format: uuid description: ID of Content Key type: type: string enum: - CommonEncryptionCenc - CommonEncryptionCbcs - EnvelopeEncryption x-ms-enum: name: StreamingLocatorContentKeyType values: - value: CommonEncryptionCenc description: Common Encryption using CENC - value: CommonEncryptionCbcs description: Common Encryption using CBCS - value: EnvelopeEncryption description: Envelope Encryption modelAsExtensible: true description: Encryption type of Content Key readOnly: true x-nullable: false label: type: string description: Label of Content Key value: type: string description: Value of Content Key policyName: type: string description: ContentKeyPolicy used by Content Key readOnly: true tracks: type: array items: $ref: '#/definitions/TrackSelection' description: Tracks which use this Content Key type: object required: - id description: Class for content key in Streaming Locator ListClusterUserCredentialProperties: type: object required: - authenticationMethod - clientProxy properties: authenticationMethod: type: string description: The mode of client authentication. enum: - Token - AAD x-ms-enum: name: AuthenticationMethod modelAsString: true clientProxy: type: boolean description: Boolean value to indicate whether the request is for client side proxy or not description: '' AccountPatchResource_2: description: Account resource patch details. type: object properties: tags: description: Resource tags. $ref: '#/definitions/Tags' properties: description: Account resource patch properties. type: object properties: endpointAuthentications: description: The list of service endpoints authentication details. $ref: '#/definitions/EndpointAuthenticationsList' cors: description: The list of CORS details. $ref: '#/definitions/CorsRuleList' reportsConnectionString: description: Connection string to write Accounts reports to. type: string identity: description: The identity used for the resource. $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity MediaService: description: The properties of a Media Service resource. example: location: West US properties: storageAccounts: - id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia isPrimary: true properties: properties: description: The additional properties of a Media Service resource. x-ms-client-flatten: true $ref: '#/definitions/MediaServiceProperties' allOf: - $ref: '#/definitions/Resource_9' AuthInfoBase: description: The authentication info discriminator: authType type: object properties: authType: description: The authentication type. $ref: '#/definitions/AuthType' authMode: description: Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. $ref: '#/definitions/AuthMode' required: - authType CheckNameAvailabilityResult: description: Result of check name availability. type: object properties: nameAvailable: type: boolean description: Indicator of availability of the Quantum Workspace resource name. reason: type: string description: The reason of unavailability. message: readOnly: true type: string description: The detailed info regarding the reason associated with the Namespace. FirewallRules: type: object description: Target service's firewall rules. to allow connections from source service. properties: ipRanges: type: array items: type: string description: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. azureServices: description: Allow Azure services to access the target service if true. $ref: '#/definitions/AllowType' callerClientIP: description: Allow caller client IP to access the target service if true. the property is used when connecting local application to target service. $ref: '#/definitions/AllowType' VideoAnalyzerProperties: properties: storageAccounts: type: array items: $ref: '#/definitions/StorageAccount' description: The storage accounts for this resource. endpoints: type: array items: $ref: '#/definitions/Endpoint' x-ms-identifiers: - endpointUrl description: The endpoints associated with this resource. readOnly: true encryption: $ref: '#/definitions/AccountEncryption' description: The account encryption properties. iotHubs: type: array items: $ref: '#/definitions/IotHub' description: The IoT Hubs for this resource. publicNetworkAccess: type: string enum: - Enabled - Disabled x-ms-enum: name: PublicNetworkAccess values: - value: Enabled description: Public network access is enabled. - value: Disabled description: Public network access is disabled. modelAsString: true description: Whether or not public network access is allowed for resources under the Video Analyzer account. x-nullable: true networkAccessControl: $ref: '#/definitions/NetworkAccessControl' description: Network access control for Video Analyzer. x-nullable: true provisioningState: type: string enum: - Failed - InProgress - Succeeded x-ms-enum: name: ProvisioningState values: - value: Failed description: Provisioning state failed. - value: InProgress description: Provisioning state in progress. - value: Succeeded description: Provisioning state succeeded. modelAsString: true description: Provisioning state of the Video Analyzer account. readOnly: true x-nullable: false privateEndpointConnections: items: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection type: array description: Private Endpoint Connections created under Video Analyzer account. readOnly: true type: object required: - storageAccounts description: The properties of the Video Analyzer account. StreamingPolicy: allOf: - $ref: ../../../Accounts/preview/2018-06-01-preview/Common.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/StreamingPolicyProperties' x-ms-client-flatten: true type: object description: A Streaming Policy resource EmptyDirVolume: description: The empty directory volume. type: object properties: {} NetworkAttachment: type: object title: NetworkAttachment represents the single network attachment. required: - attachedNetworkId - ipAllocationMethod properties: attachedNetworkId: description: 'The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.' type: string format: arm-id x-ms-mutability: - read - create defaultGateway: description: 'The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.' type: string enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: DefaultGateway ipAllocationMethod: description: 'The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.' type: string enum: - Dynamic - Static - Disabled x-ms-enum: modelAsString: true name: VirtualMachineIPAllocationMethod x-ms-mutability: - read - create ipv4Address: description: 'The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty.' type: string x-ms-mutability: - read - create ipv6Address: description: 'The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty.' type: string x-ms-mutability: - read - create macAddress: description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. type: string readOnly: true networkAttachmentName: description: 'The associated network''s interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored.' type: string maxLength: 15 x-ms-mutability: - read - create DirectoryTenantHealthReport: description: A report of the health status of a directory tenant and identity applications within. type: object properties: tenantId: description: The tenant unique identifier. type: string tenantName: description: The directory tenant resource name. type: string status: description: The roll-up health status for the directory. $ref: '#/definitions/HealthStatus' applications: description: List of the application health reports. $ref: '#/definitions/ApplicationHealthReportList' VirtualHubProperties: properties: virtualWan: $ref: ./network.json#/definitions/SubResource description: The VirtualWAN to which the VirtualHub belongs. vpnGateway: $ref: ./network.json#/definitions/SubResource description: The VpnGateway associated with this VirtualHub. p2SVpnGateway: $ref: ./network.json#/definitions/SubResource description: The P2SVpnGateway associated with this VirtualHub. expressRouteGateway: $ref: ./network.json#/definitions/SubResource description: The expressRouteGateway associated with this VirtualHub. azureFirewall: $ref: ./network.json#/definitions/SubResource description: The azureFirewall associated with this VirtualHub. securityPartnerProvider: $ref: ./network.json#/definitions/SubResource description: The securityPartnerProvider associated with this VirtualHub. addressPrefix: type: string description: Address-prefix for this VirtualHub. routeTable: $ref: '#/definitions/VirtualHubRouteTable' description: The routeTable associated with this virtual hub. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the virtual hub resource. securityProviderName: type: string description: The Security Provider name. virtualHubRouteTableV2s: type: array description: List of all virtual hub route table v2s associated with this VirtualHub. items: $ref: '#/definitions/VirtualHubRouteTableV2' sku: type: string description: The sku of this VirtualHub. routingState: $ref: '#/definitions/RoutingState' description: The routing state. bgpConnections: type: array readOnly: true description: List of references to Bgp Connections. items: $ref: ./network.json#/definitions/SubResource ipConfigurations: type: array readOnly: true description: List of references to IpConfigurations. items: $ref: ./network.json#/definitions/SubResource routeMaps: type: array readOnly: true description: List of references to RouteMaps. items: $ref: ./network.json#/definitions/SubResource virtualRouterAsn: type: integer readOnly: false format: int64 minimum: 0 maximum: 4294967295 description: VirtualRouter ASN. virtualRouterIps: type: array readOnly: false description: VirtualRouter IPs. items: type: string allowBranchToBranchTraffic: type: boolean readOnly: false description: Flag to control transit for VirtualRouter hub. preferredRoutingGateway: $ref: '#/definitions/PreferredRoutingGateway' description: The preferred gateway to route on-prem traffic hubRoutingPreference: $ref: '#/definitions/HubRoutingPreference' description: The hubRoutingPreference of this VirtualHub. virtualRouterAutoScaleConfiguration: $ref: '#/definitions/VirtualRouterAutoScaleConfiguration' description: The VirtualHub Router autoscale configuration. description: Parameters for VirtualHub. CommandPostBody: description: Specification of which command to run where type: object required: - command - host properties: command: type: string description: The command which should be run arguments: type: object description: The arguments for the command to be run host: type: string description: IP address of the cassandra host to run the command on cassandra-stop-start: type: boolean description: If true, stops cassandra before executing the command and then start it again readWrite: type: boolean description: If true, allows the command to *write* to the cassandra directory, otherwise read-only. OAuth2PermissionGrantHealthReport: description: A report of the health status of an OAuth2PermissionGrant. type: object properties: oAuth2PermissionGrant: description: The permission description. $ref: '#/definitions/OAuth2PermissionGrantDefinition' status: description: The health status for the permission. $ref: '#/definitions/HealthStatus' DnsNameAvailabilityResult: properties: available: type: boolean description: Domain availability (True/False) description: Response for CheckDnsNameAvailability Api service call ActivityLogAlertResource: type: object description: An Activity Log Alert rule resource. allOf: - $ref: '#/definitions/AzureResource_2' properties: properties: description: The Activity Log Alert rule properties of the resource. x-ms-client-flatten: true $ref: '#/definitions/AlertRuleProperties' SkuCost: description: Describes metadata for retrieving price info. type: object properties: meterId: description: Meter id of the Sku. type: string readOnly: true meterType: description: The type of the meter. type: string readOnly: true multiplier: format: double description: 'Multiplier specifies the region specific value to be multiplied with 1$ guid. Eg: Our new regions will be using 1$ shipping guid with appropriate multiplier specific to region.' type: number readOnly: true AgreementTerms: properties: properties: $ref: '#/definitions/AgreementProperties' description: Represents the properties of the resource. x-ms-client-flatten: true systemData: readOnly: true description: The system meta data relating to this resource. $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData allOf: - $ref: '#/definitions/Resource_8' description: Terms properties for provided Publisher/Offer/Plan tuple VolumeProperties: type: object title: VolumeProperties represents properties of the volume resource. required: - sizeMiB properties: attachedTo: description: The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. type: array items: type: string readOnly: true detailedStatus: description: The more detailed status of the volume. type: string enum: - Error - Active - Provisioning x-ms-enum: modelAsString: true name: VolumeDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true provisioningState: description: The provisioning state of the volume. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted x-ms-enum: modelAsString: true name: VolumeProvisioningState readOnly: true serialNumber: description: The unique identifier of the volume. type: string readOnly: true sizeMiB: description: The size of the allocation for this volume in Mebibytes. type: integer format: int64 minimum: 1 x-ms-mutability: - read - create ServiceKeys: description: The response body for a ListKeys API. example: primaryAuthEndpoint: https://wamsprodglobal001acs.accesscontrol.windows.net/ secondaryAuthEndpoint: https://wamsprodglobal002acs.accesscontrol.windows.net/ primaryKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= secondaryKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= scope: urn:windowsazuremediaservices properties: primaryAuthEndpoint: description: The primary authorization endpoint. type: string secondaryAuthEndpoint: description: The secondary authorization endpoint. type: string primaryKey: description: The primary key for the Media Service resource. type: string secondaryKey: description: The secondary key for the Media Service resource. type: string scope: description: The authorization scope. type: string PremierAddOnOffer: description: Premier add-on offer. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: PremierAddOnOffer resource specific properties type: object properties: sku: description: Premier add on SKU. type: string product: description: Premier add on offer Product. type: string vendor: description: Premier add on offer Vendor. type: string promoCodeRequired: description: true if promotion code is required; otherwise, false. type: boolean quota: format: int32 description: Premier add on offer Quota. type: integer webHostingPlanRestrictions: description: App Service plans this offer is restricted to. enum: - None - Free - Shared - Basic - Standard - Premium type: string x-ms-enum: name: AppServicePlanRestrictions modelAsString: false privacyPolicyUrl: description: Privacy policy URL. type: string legalTermsUrl: description: Legal terms URL. type: string marketplacePublisher: description: Marketplace publisher. type: string marketplaceOffer: description: Marketplace offer. type: string x-ms-client-flatten: true GetInboundRoutesParameters: description: The parameters specifying the connection resource whose inbound routes are being requested. type: object properties: resourceUri: type: string description: The connection resource whose inbound routes are being requested. connectionType: type: string description: The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection. virtualNetworksPatch: type: object properties: tags: type: object additionalProperties: type: string description: Resource tags description: The virtualNetworks resource patch definition. Resource_8: description: ARM resource. properties: id: readOnly: true type: string description: Resource ID. name: readOnly: true type: string description: Resource name. type: readOnly: true type: string description: Resource type. x-ms-azure-resource: true ConnectedClusterPatchProperties: type: object properties: distribution: type: string description: Represents the distribution of the connected cluster distributionVersion: type: string description: Represents the Kubernetes distribution version on this connected cluster. azureHybridBenefit: type: string description: Indicates whether Azure Hybrid Benefit is opted in enum: - 'True' - 'False' - NotApplicable x-ms-enum: name: AzureHybridBenefit modelAsString: true description: Properties which can be patched on the connected cluster resource. AzureDevOpsOrg: description: Azure DevOps Org Proxy Resource. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/AzureDevOpsOrgProperties' CloudError_9: x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody_8' description: Cloud error body. description: An error response from the service. Disk_2: properties: name: type: string description: The disk name. diskSizeGB: type: integer format: int32 description: Specifies the size of an empty data disk in gigabytes. lun: readOnly: true type: integer format: int32 description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. description: Specifies the disk information fo the AzureBareMetal instance Errors.WorkspaceItemError: type: object description: The error object. properties: code: type: string description: One of a server-defined set of error codes. message: type: string description: A human-readable representation of the error. target: type: string description: The target of the error. details: type: array description: An array of details about specific errors that led to this reported error. items: $ref: '#/definitions/Azure.Core.Foundations.Error' x-ms-identifiers: [] innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: An object containing more specific information than the current object about the error. required: - code - message Resource_10: description: The resource model definition for the ARM proxy resource, 'microsoft.workloadmonitor/monitors'. type: object properties: id: readOnly: true description: The resource Id. type: string example: /subscriptions/bc27da3b-3ba2-4e00-a6ec-1fde64aa1e21/resourceGroups/tugamidiAlerts/providers/Microsoft.Compute/virtualMachines/linuxEUS/providers/Microsoft.WorkloadMonitor/monitors/logical-disks|C@3A name: readOnly: true description: The resource name. type: string example: logical-disks|C@3A type: readOnly: true description: The resource type. type: string example: Microsoft.WorkloadMonitor/monitors x-ms-azure-resource: true EffectiveRouteMapRoute: description: The effective RouteMap route configured on the connection resource. type: object properties: prefix: description: The address prefix of the route. type: string bgpCommunities: description: BGP communities of the route. type: string asPath: description: The ASPath of this route. type: string VpnSiteLinkConnectionProperties: properties: vpnSiteLink: $ref: ./network.json#/definitions/SubResource description: Id of the connected vpn site link. routingWeight: type: integer format: int32 description: Routing weight for vpn connection. vpnLinkConnectionMode: type: string description: Vpn link connection mode. enum: - Default - ResponderOnly - InitiatorOnly x-ms-enum: name: VpnLinkConnectionMode modelAsString: true connectionStatus: description: The connection status. $ref: '#/definitions/VpnConnectionStatus' vpnConnectionProtocolType: description: Connection protocol used for this connection. $ref: ./virtualNetworkGateway.json#/definitions/ConnectionProtocol ingressBytesTransferred: type: integer format: int64 readOnly: true description: Ingress bytes transferred. egressBytesTransferred: type: integer format: int64 readOnly: true description: Egress bytes transferred. connectionBandwidth: type: integer format: int32 description: Expected bandwidth in MBPS. sharedKey: type: string description: SharedKey for the vpn connection. enableBgp: type: boolean description: EnableBgp flag. vpnGatewayCustomBgpAddresses: type: array items: $ref: ./virtualNetworkGateway.json#/definitions/GatewayCustomBgpIpAddressIpConfiguration description: vpnGatewayCustomBgpAddresses used by this connection. x-ms-identifiers: [] usePolicyBasedTrafficSelectors: type: boolean description: Enable policy-based traffic selectors. ipsecPolicies: type: array items: $ref: ./virtualNetworkGateway.json#/definitions/IpsecPolicy description: The IPSec Policies to be considered by this connection. enableRateLimiting: type: boolean description: EnableBgp flag. useLocalAzureIpAddress: type: boolean description: Use local azure ip to initiate connection. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the VPN site link connection resource. ingressNatRules: type: array items: $ref: ./network.json#/definitions/SubResource description: List of ingress NatRules. egressNatRules: type: array items: $ref: ./network.json#/definitions/SubResource description: List of egress NatRules. dpdTimeoutSeconds: type: integer format: int32 description: Dead Peer Detection timeout in seconds for VpnLink connection. description: Parameters for VpnConnection. ComponentPurgeBodyFilters: description: User-defined filters to return data which will be purged from the table. properties: column: description: The column of the table over which the given query should run type: string operator: description: A query operator to evaluate over the provided column and value(s). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query. type: string value: description: the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values. key: description: When filtering over custom dimensions, this key will be used as the name of the custom dimension. type: string PrecheckResult: type: object properties: name: description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. type: string displayName: description: The health check DisplayName localized of the individual test executed. type: string tags: description: Key-value pairs that allow grouping/filtering individual tests. type: object properties: key: description: Key that allow grouping/filtering individual tests. type: string value: description: Value of the key that allow grouping/filtering individual tests. type: string title: description: User-facing name; one or more sentences indicating the direct issue. type: string status: description: The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed. type: string enum: - Succeeded - Failed - InProgress x-ms-enum: name: status modelAsString: true severity: description: Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity. type: string enum: - Critical - Warning - Informational - Hidden x-ms-enum: name: severity modelAsString: true description: description: Detailed overview of the issue and what impact the issue has on the stamp. type: string remediation: description: Set of steps that can be taken to resolve the issue found. type: string targetResourceID: description: The unique identifier for the affected resource (such as a node or drive). type: string targetResourceName: description: The name of the affected resource. type: string timestamp: description: The Time in which the HealthCheck was called. type: string format: date-time additionalData: description: Property bag of key value pairs for additional information. type: string healthCheckSource: description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). type: string ConnectedClusterKind: type: string description: Indicates the kind of Arc connected cluster based on host infrastructure. enum: - ProvisionedCluster x-ms-enum: name: ConnectedClusterKind modelAsString: true logAnalyticsUpdateConfiguration: type: object description: Updated configuration for Log Analytics linking properties: dataTypes: description: The types of data to be ingested to Log Analytics workspace. type: array items: type: string enum: - State - Performance - Event - Audit x-ms-enum: name: DataType modelAsString: true VpnSiteLink: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnSiteLinkProperties' description: Properties of the VPN site link. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. type: readOnly: true type: string description: Resource type. allOf: - $ref: ./network.json#/definitions/SubResource description: VpnSiteLink Resource. OfficeTrafficCategory: type: string description: The office traffic category. readOnly: true enum: - Optimize - OptimizeAndAllow - All - None x-ms-enum: name: OfficeTrafficCategory modelAsString: true DetectorResponse: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/DetectorResponseProperties' description: The properties associated with the detector. allOf: - $ref: '#/definitions/ProxyResource' description: Contains the information for a detector. ScopeStatuses: description: Scope statuses. type: object properties: scope: description: The scope that the statuses refers to. type: string statuses: description: Scope stage statuses. type: array items: $ref: '#/definitions/StageStatus' x-ms-identifiers: [] ComponentPurgeResponse: description: Response containing operationId for a specific purge action. properties: operationId: description: Id to use when querying for status for a particular purge operation. type: string required: - operationId pipelinesListResult: type: object properties: value: type: array items: $ref: '#/definitions/pipeline' description: Pipelines array. x-ms-identifiers: - id nextLink: description: Link to next results type: string description: The pipelines list result. LoadBasedConfig: type: object description: Profile of load based Autoscale. required: - minNodes - maxNodes - scalingRules properties: minNodes: type: integer format: int32 description: User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. maxNodes: type: integer format: int32 description: User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. pollInterval: type: integer format: int32 description: User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation. cooldownPeriod: type: integer format: int32 description: This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds. scalingRules: type: array description: The scaling rules. items: $ref: '#/definitions/ScalingRule' x-ms-identifiers: [] ExtensionTypeList: description: List Extension Types type: object properties: value: description: The list of Extension Types type: array items: $ref: '#/definitions/ExtensionType' nextLink: description: The link to fetch the next page of Extension Types type: string ComponentPurgeStatusResponse: description: Response containing status for a specific purge operation. properties: status: description: Status of the operation represented by the requested Id. type: string enum: - pending - completed x-ms-enum: name: PurgeState modelAsString: true required: - status AuthenticationMethodLdapProperties: type: object description: Ldap authentication method properties. This feature is in preview. properties: serverHostname: description: Hostname of the LDAP server. type: string serverPort: description: Port of the LDAP server. type: integer format: int32 serviceUserDistinguishedName: description: Distinguished name of the look up user account, who can look up user details on authentication. type: string serviceUserPassword: description: Password of the look up user. type: string searchBaseDistinguishedName: description: Distinguished name of the object to start the recursive search of users from. type: string searchFilterTemplate: description: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. type: string serverCertificates: type: array items: $ref: '#/definitions/Certificate' connectionTimeoutInMs: description: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms. type: integer format: int32 ValidationRequest: description: Minimum request requirement of any validation category. required: - validationCategory - individualRequestDetails type: object properties: validationCategory: description: Identify the nature of validation. enum: - JobCreationValidation type: string x-ms-enum: name: ValidationCategory modelAsExtensible: true values: - value: JobCreationValidation description: Identify request of pre-job creation validations. individualRequestDetails: description: List of request details contain validationType and its request as key and value respectively. type: array items: $ref: '#/definitions/ValidationInputRequest' discriminator: validationCategory ProjectProperties: type: object description: Properties of a project. properties: numberOfMachines: type: integer format: int32 description: Number of machines in the project. readOnly: true numberOfGroups: type: integer format: int32 description: Number of groups created in the project. readOnly: true numberOfAssessments: type: integer format: int32 description: Number of assessments created in the project. readOnly: true createdTimestamp: type: string format: date-time description: Time when this project was created. Date-Time represented in ISO-8601 format. readOnly: true updatedTimestamp: type: string format: date-time description: Time when this project was last updated. Date-Time represented in ISO-8601 format. readOnly: true discoveryStatus: type: string enum: - Unknown - NotStarted - InProgress - Completed readOnly: true description: Reports whether project is under discovery. x-ms-enum: name: DiscoveryStatus modelAsString: true customerWorkspaceId: type: string description: ARM ID of the Service Map workspace created by user. provisioningState: type: string enum: - Accepted - Creating - Deleting - Failed - Moving - Succeeded description: Provisioning state of the project. x-ms-enum: name: ProvisioningState modelAsString: true AadConfiguration: type: object title: AadConfiguration represents the Azure Active Directory Integration properties. required: - adminGroupObjectIds properties: adminGroupObjectIds: description: The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster. type: array minItems: 1 items: type: string x-ms-mutability: - read - create KubernetesConfigurationPrivateLinkScopeListResult: type: object description: Describes the list of Azure Arc PrivateLinkScope resources. required: - value properties: value: type: array description: List of Azure Arc PrivateLinkScope definitions. items: $ref: '#/definitions/KubernetesConfigurationPrivateLinkScope' nextLink: type: string description: The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set. ServiceEndpointResource: description: ServiceEndpoint resource details. type: object allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource properties: properties: description: ServiceEndpoint resource properties. type: object properties: preAllocatedCapacity: description: ServiceEndpoint pre-allocated capacity controls the maximum requests-per-second allowed for that endpoint. Only applicable when Account configuration is Capacity. type: integer x-ms-mutability: - read - create format: int32 minimum: 0 pairedLocation: description: The paired location that will be used by this ServiceEndpoint. type: string readOnly: true url: description: The URL where the ServiceEndpoint API is accessible at. type: string readOnly: true provisioningState: description: The resource provisioning state. type: string readOnly: true systemData: description: Metadata pertaining to creation and last modification of the resource. $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData KeyVaultProperties: type: object description: Properties of the key vault. required: - keyName - keyVaultUri properties: keyName: type: string description: The name of the key vault key. x-ms-client-name: KeyName keyVersion: type: string description: The version of the key vault key. x-ms-client-name: KeyVersion keyVaultUri: type: string description: The Uri of the key vault. x-ms-client-name: KeyVaultUri userIdentity: type: string description: The user assigned identity (ARM resource id) that has access to the key. x-ms-client-name: UserIdentity TrackedResource: type: object description: The resource model definition for a ARM tracked top level resource properties: tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags. location: type: string x-ms-mutability: - read - create description: The geo-location where the resource lives required: - location allOf: - $ref: '#/definitions/Resource' ContainerProbe: type: object description: The container probe, for liveness or readiness properties: exec: description: The execution command to probe $ref: '#/definitions/ContainerExec' httpGet: description: The Http Get settings to probe $ref: '#/definitions/ContainerHttpGet' initialDelaySeconds: description: The initial delay seconds. type: integer format: int32 periodSeconds: description: The period seconds. type: integer format: int32 failureThreshold: description: The failure threshold. type: integer format: int32 successThreshold: description: The success threshold. type: integer format: int32 timeoutSeconds: description: The timeout seconds. type: integer format: int32 CloudHsmClusterPatchParameters: properties: tags: type: object description: The Cloud HSM Cluster's tags additionalProperties: type: string description: The Cloud HSM Cluster's tag's additional properties sku: $ref: '#/definitions/CloudHsmClusterSku' description: SKU details identity: $ref: ../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity properties: x-ms-client-flatten: true type: object description: Properties of the Cloud HSM Cluster properties: backupProperties: $ref: '#/definitions/BackupProperties' description: Patchable properties of the Cloud HSM Cluster type: object HubRouteTableProperties: properties: routes: type: array description: List of all routes. items: $ref: '#/definitions/HubRoute' labels: type: array description: List of labels associated with this route table. items: type: string associatedConnections: type: array description: List of all connections associated with this route table. readOnly: true items: type: string propagatingConnections: type: array description: List of all connections that advertise to this route table. readOnly: true items: type: string provisioningState: $ref: ./network.json#/definitions/ProvisioningState readOnly: true description: The provisioning state of the RouteTable resource. description: Parameters for RouteTable. ReceiverStatus: type: string enum: - NotSpecified - Enabled - Disabled x-ms-enum: name: ReceiverStatus modelAsString: false description: Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications. RegionConfigurationRequest: description: Request body to get the configuration for the region. type: object properties: scheduleAvailabilityRequest: $ref: '#/definitions/ScheduleAvailabilityRequest' description: Request body to get the availability for scheduling orders. transportAvailabilityRequest: $ref: '#/definitions/TransportAvailabilityRequest' description: Request body to get the transport availability for given sku. datacenterAddressRequest: $ref: '#/definitions/DatacenterAddressRequest' description: Request body to get the datacenter address for given sku. deviceCapabilityRequest: $ref: '#/definitions/DeviceCapabilityRequest' description: Request body to get the device capabilities for a given sku. DocumentProcessorResource: type: object description: Document processor details allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource properties: properties: x-ms-client-flatten: false description: Document processor properties. $ref: '#/definitions/DocumentProcessorProperties' ClusterManagerProperties: type: object title: ClusterManagerProperties represents the properties of a cluster manager. required: - fabricControllerId properties: analyticsWorkspaceId: description: The resource ID of the Log Analytics workspace that is used for the logs collection. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.OperationalInsights/workspaces x-ms-mutability: - read - create availabilityZones: description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource. type: array items: type: string x-ms-identifiers: [] x-ms-mutability: - read - create clusterVersions: description: The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource. type: array items: $ref: '#/definitions/ClusterAvailableVersion' x-ms-identifiers: - targetClusterVersion readOnly: true detailedStatus: description: The detailed status that provides additional information about the cluster manager. type: string enum: - Error - Available - Provisioning - ProvisioningFailed - Updating - UpdateFailed x-ms-enum: modelAsString: true name: ClusterManagerDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true fabricControllerId: description: The resource ID of the fabric controller that has one to one mapping with the cluster manager. type: string format: arm-id x-ms-mutability: - read - create managedResourceGroupConfiguration: $ref: '#/definitions/ManagedResourceGroupConfiguration' description: The configuration of the managed resource group associated with the resource. managerExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources. readOnly: true provisioningState: description: The provisioning state of the cluster manager. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted - Updating x-ms-enum: modelAsString: true name: ClusterManagerProvisioningState readOnly: true vmSize: description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource. type: string x-ms-mutability: - read - create EventLogConfiguration: type: object required: - logName properties: logName: type: string filter: type: string ClusterPatchProperties_2: type: object title: ClusterPatchProperties represents the properties of the cluster for patching. properties: aggregatorOrSingleRackDefinition: $ref: '#/definitions/RackDefinition' description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. clusterLocation: description: The customer-provided location information to identify where the cluster resides. type: string clusterServicePrincipal: $ref: '#/definitions/ServicePrincipalInformation' description: The service principal to be used by the cluster during Arc Appliance installation. computeDeploymentThreshold: $ref: '#/definitions/ValidationThreshold' description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. computeRackDefinitions: description: 'The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.' type: array items: $ref: '#/definitions/RackDefinition' x-ms-identifiers: - networkRackId runtimeProtectionConfiguration: $ref: '#/definitions/RuntimeProtectionConfiguration' description: The settings for cluster runtime protection. secretArchive: $ref: '#/definitions/ClusterSecretArchive' description: The configuration for use of a key vault to store secrets for later retrieval by the operator. updateStrategy: $ref: '#/definitions/ClusterUpdateStrategy' description: The strategy for updating the cluster. RuntimeProtectionConfiguration: type: object title: RuntimeProtectionConfiguration represents the runtime protection configuration for the cluster. properties: enforcementLevel: description: The mode of operation for runtime protection. type: string default: Disabled enum: - Audit - Disabled - OnDemand - Passive - RealTime x-ms-enum: modelAsString: true name: RuntimeProtectionEnforcementLevel ProvisioningState: type: string description: Provisioning state of the service. enum: - Succeeded - Failed - Canceled x-ms-enum: name: ProvisioningState modelAsString: true readOnly: true QueryFailure: description: Error response. properties: error: description: Error definition. properties: code: description: Service specific error code which serves as the substatus for the HTTP error code. type: string readOnly: true message: description: Description of the error. type: string readOnly: true CHsmError: properties: code: type: string readOnly: true description: The error code. message: type: string readOnly: true description: The error message. type: object description: Error details BmcKeySet: type: object title: BmcKeySet represents the baseboard management controller key set. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/BmcKeySetProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true PrivateEndpointUpdate: description: Private endpoint update details. type: object properties: id: description: Remote endpoint resource ID. type: string location: description: ARM location of the remote private endpoint. type: string immutableSubscriptionId: description: Original subscription ID needed by Microsoft.Network. type: string immutableResourceId: description: Original resource ID needed by Microsoft.Network. type: string vnetTrafficTag: description: Virtual network traffic tag. type: string IfNotExistsEvaluationDetails: type: object description: Evaluation details of IfNotExists effect. properties: resourceId: description: ID of the last evaluated resource for IfNotExists effect. type: string totalResources: description: Total number of resources to which the existence condition is applicable. type: integer StreamingLocator: allOf: - $ref: ../../../Accounts/preview/2018-06-01-preview/Common.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/StreamingLocatorProperties' x-ms-client-flatten: true type: object description: A Streaming Locator resource AssessedMachineResultList: type: object description: List of assessed machines. properties: value: description: List of assessed machines. type: array items: $ref: '#/definitions/AssessedMachine' PrivateEndpointConnectionProxyProperties: description: Private endpoint connection proxy object properties. type: object x-ms-client-flatten: true properties: eTag: description: ETag from NRP. type: string readOnly: true remotePrivateEndpoint: description: Remote private endpoint details. $ref: '#/definitions/RemotePrivateEndpoint' status: description: Operation status. type: string 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. metadataFunction: title: A stored function. description: Functions are stored Kusto queries that can be specified as part of queries by using their name. type: object properties: id: description: The ID of the function. type: string name: description: The name of the function, to be used in queries. type: string parameters: description: The parameters/arguments of the function, if any. type: string displayName: description: The display name of the function. type: string description: description: The description of the function. type: string body: description: The KQL body of the function. type: string required: - id - name - body VnetLocalRouteOverrideCriteria: type: string description: Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet. enum: - Contains - Equal x-ms-enum: name: VnetLocalRouteOverrideCriteria modelAsString: true ListVpnSiteLinkConnectionsResult: description: Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnSiteLinkConnection' description: List of VpnSiteLinkConnections. nextLink: type: string description: URL to get the next set of operation list results if there are any. pipelineProperties: type: object properties: remoteCloud: type: string description: Remote cloud of the data to be transferred or received displayName: type: string description: Display name of this pipeline connections: type: array items: $ref: '#/definitions/pipelineConnection' description: Connections associated with pipeline readOnly: true x-ms-identifiers: - id subscribers: type: array items: $ref: '#/definitions/subscriber' x-ms-identifiers: [] description: Subscribers of this resource provisioningState: description: Provisioning state of the pipeline enum: - Failed - Succeeded - Canceled - Accepted type: string x-ms-enum: name: provisioningState modelAsString: true readOnly: true policies: type: array description: The policies for this pipeline items: type: string flowTypes: $ref: '#/definitions/flowTypes' description: The flow types allowed for this pipeline required: - remoteCloud description: Properties of pipeline PendingField: description: A field that should be evaluated against Azure Policy to determine restrictions. properties: field: description: The name of the field. This can be a top-level property like 'name' or 'type' or an Azure Policy field alias. type: string values: description: The list of potential values for the field that should be evaluated against Azure Policy. type: array items: type: string required: - field TagsResource_3: type: object properties: tags: type: object additionalProperties: type: string description: Resource tags description: A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance. KubernetesLabel: type: object title: KubernetesLabel represents a single entry for a Kubernetes label or taint such as those used on a node or pod. required: - key - value properties: key: description: The name of the label or taint. type: string x-ms-mutability: - read - create value: description: The value of the label or taint. type: string x-ms-mutability: - read - create BillingMeter: description: App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: BillingMeter resource specific properties type: object properties: meterId: description: Meter GUID onboarded in Commerce type: string billingLocation: description: Azure Location of billable resource type: string shortName: description: Short Name from App Service Azure pricing Page type: string friendlyName: description: Friendly name of the meter type: string resourceType: description: App Service ResourceType meter used for type: string osType: description: App Service OS type meter used for type: string multiplier: format: double description: Meter Multiplier type: number x-ms-client-flatten: true BareMetalMachineKeySetPatchProperties: type: object title: BareMetalMachineKeySetPatchProperties represents the properties of bare metal machine key set that can be patched. properties: expiration: description: The date and time after which the users in this key set will be removed from the bare metal machines. type: string format: date-time jumpHostsAllowed: description: The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. type: array items: type: string userList: description: The unique list of permitted users. type: array items: $ref: '#/definitions/KeySetUser' x-ms-identifiers: - azureUserName AgentPoolProperties: type: object title: AgentPoolProperties represents the properties of the Kubernetes cluster agent pool. required: - count - mode - vmSkuName properties: administratorConfiguration: $ref: '#/definitions/AdministratorConfiguration' description: The administrator credentials to be used for the nodes in this agent pool. x-ms-mutability: - read - create agentOptions: $ref: '#/definitions/AgentOptions' description: The configurations that will be applied to each agent in this agent pool. x-ms-mutability: - read - create attachedNetworkConfiguration: $ref: '#/definitions/AttachedNetworkConfiguration' description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. x-ms-mutability: - read - create availabilityZones: description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. type: array items: type: string x-ms-mutability: - read - create count: description: The number of virtual machines that use this configuration. type: integer format: int64 detailedStatus: description: The current status of the agent pool. type: string enum: - Available - Error - Provisioning x-ms-enum: modelAsString: true name: AgentPoolDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true kubernetesVersion: description: The Kubernetes version running in this agent pool. type: string readOnly: true labels: description: The labels applied to the nodes in this agent pool. type: array items: $ref: '#/definitions/KubernetesLabel' x-ms-mutability: - read - create mode: description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. type: string enum: - System - User - NotApplicable x-ms-enum: modelAsString: true name: AgentPoolMode x-ms-mutability: - read - create provisioningState: description: The provisioning state of the agent pool. type: string enum: - Accepted - Canceled - Deleting - Failed - InProgress - Succeeded - Updating x-ms-enum: modelAsString: true name: AgentPoolProvisioningState readOnly: true taints: description: The taints applied to the nodes in this agent pool. type: array items: $ref: '#/definitions/KubernetesLabel' x-ms-mutability: - read - create upgradeSettings: $ref: '#/definitions/AgentPoolUpgradeSettings' description: The configuration of the agent pool. vmSkuName: description: The name of the VM SKU that determines the size of resources allocated for node VMs. type: string x-ms-mutability: - read - create PrivateEndpointConnectionProperties_3: type: object description: Properties of a private endpoint connection. properties: privateEndpoint: $ref: '#/definitions/PrivateEndpointProperty' description: Private endpoint which the connection belongs to. privateLinkServiceConnectionState: $ref: '#/definitions/PrivateLinkServiceConnectionStateProperty' description: Connection state of the private endpoint connection. provisioningState: description: State of the private endpoint connection. type: string readOnly: true groupIds: description: List of group IDs. type: array items: type: string readOnly: true virtualNetworksProperties: type: object x-ms-client-flatten: true properties: infraVnetProfile: type: object properties: hci: type: object properties: mocGroup: type: string description: Resource group in MOC(Microsoft On-premises Cloud) mocLocation: type: string description: Location in MOC(Microsoft On-premises Cloud) mocVnetName: type: string description: Virtual Network name in MOC(Microsoft On-premises Cloud) description: Infra network profile for HCI platform kubevirt: type: object properties: vnetName: type: string description: Name of the network in KubeVirt description: Infra network profile for KubeVirt platform vmware: type: object properties: segmentName: type: string description: Name of the network segment in VSphere description: Infra network profile for VMware platform vipPool: type: array description: Virtual IP Pool for Kubernetes x-ms-identifiers: [] items: type: object properties: endIP: type: string description: Ending IP address for the IP Pool startIP: type: string description: Starting IP address for the IP Pool vmipPool: type: array description: IP Pool for Virtual Machines x-ms-identifiers: [] items: type: object properties: endIP: type: string description: Ending IP address for the IP Pool startIP: type: string description: Starting IP address for the IP Pool dhcpServers: type: array readOnly: true description: Address of the DHCP servers associated with the network items: type: string dnsServers: type: array readOnly: true description: Address of the DNS servers associated with the network items: type: string gateway: type: string readOnly: true description: Address of the Gateway associated with the network ipAddressPrefix: type: string readOnly: true description: IP Address Prefix of the network vlanID: type: string readOnly: true description: VLAN Id used by the network provisioningState: type: string readOnly: true enum: - Succeeded - Failed - Canceled - InProgress - Deleting - Updating - Accepted - Created x-ms-enum: modelAsString: true name: provisioningState status: type: object readOnly: true properties: provisioningStatus: type: object properties: error: type: object properties: code: type: string message: type: string operationId: type: string phase: type: string description: Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc. status: type: string description: Contains Provisioning errors description: HybridAKSNetworkStatus defines the observed state of HybridAKSNetwork description: HybridAKSNetworkSpec defines the desired state of HybridAKSNetwork CloudError_5: type: object x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody_4' description: Cloud error body. description: An error response from the service. DefaultKey: properties: label: type: string description: Label can be used to specify Content Key when creating a Streaming Locator policyName: type: string description: Policy used by Default Key type: object description: Class to specify properties of default content key for each encryption scheme VirtualMachinePowerOffParameters: type: object title: VirtualMachinePowerOffParameters represents the body of the request to power off virtual machine. properties: skipShutdown: description: The indicator of whether to skip the graceful OS shutdown and power off the virtual machine immediately. type: string default: 'False' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: SkipShutdown LldpNeighbor: type: object title: Type Deprecated. Will be removed in an upcoming version. LldpNeighbor represents the details about the device connected to the NIC. properties: portDescription: description: The descriptive information about the port on the connected device. type: string readOnly: true portName: description: The system-assigned name of the port on the connected device. type: string readOnly: true systemDescription: description: The descriptive information about the connected device. type: string readOnly: true systemName: description: The system-assigned name of the connected device. type: string readOnly: true ExtensionTypeProperties: description: Properties of the connected cluster. type: object properties: releaseTrains: readOnly: true type: array items: type: string description: 'Extension release train: preview or stable' clusterTypes: description: Cluster types readOnly: true type: string enum: - connectedClusters - managedClusters x-ms-enum: name: clusterTypes modelAsString: false supportedScopes: readOnly: true type: object description: Extension scopes $ref: '#/definitions/SupportedScopes' ServiceProperties: type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. description: The properties of the service. ResourceIdentity: properties: userAssignedIdentity: type: string description: The user assigned managed identity's resource identifier to use when accessing a resource. type: object required: - userAssignedIdentity description: The user assigned managed identity to use when accessing a resource. SinkConfiguration: type: object required: - kind properties: kind: type: string enum: - EventHub - ApplicationInsights - LogAnalytics SkuProperties: description: Properties of the sku. type: object properties: dataLocationToServiceLocationMap: description: The map of data location to service location. type: array items: $ref: '#/definitions/DataLocationToServiceLocationMap' readOnly: true capacity: $ref: '#/definitions/SkuCapacity' description: Capacity of the Sku. readOnly: true costs: description: Cost of the Sku. type: array items: $ref: '#/definitions/SkuCost' readOnly: true apiVersions: description: Api versions that support this Sku. type: array items: type: string readOnly: true disabledReason: description: Reason why the Sku is disabled. enum: - None - Country - Region - Feature - OfferType - NoSubscriptionInfo type: string readOnly: true x-ms-enum: name: SkuDisabledReason modelAsExtensible: true values: - value: None description: SKU is not disabled. - value: Country description: SKU is not available in the requested country. - value: Region description: SKU is not available to push data to the requested Azure region. - value: Feature description: Required features are not enabled for the SKU. - value: OfferType description: Subscription does not have required offer types for the SKU. - value: NoSubscriptionInfo description: Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification. disabledReasonMessage: description: Message for why the Sku is disabled. type: string readOnly: true requiredFeature: description: Required feature to access the sku. type: string readOnly: true countriesWithinCommerceBoundary: description: List of all the Countries in the SKU specific commerce boundary type: array items: type: string readOnly: true UpdateList: description: List of Updates type: object properties: value: description: List of Updates type: array items: $ref: '#/definitions/Update' nextLink: description: Link to the next set of results. type: string readOnly: true CloudErrorBody_6: 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_6' description: A list of additional details about the error. description: An error response from the ManagedServiceIdentity service. SupportedScopes: type: object description: Extension scopes properties: defaultScope: type: string description: 'Default extension scopes: cluster or namespace' clusterScopeSettings: description: Scope settings $ref: '#/definitions/ClusterScopeSettings' BgpConnectionProperties: properties: peerAsn: type: integer readOnly: false format: int64 minimum: 0 maximum: 4294967295 description: Peer ASN. peerIp: type: string readOnly: false description: Peer IP. hubVirtualNetworkConnection: description: The reference to the HubVirtualNetworkConnection resource. readOnly: false $ref: ./network.json#/definitions/SubResource provisioningState: description: The provisioning state of the resource. readOnly: true $ref: ./network.json#/definitions/ProvisioningState connectionState: type: string description: The current state of the VirtualHub to Peer. readOnly: true enum: - Unknown - Connecting - Connected - NotConnected x-ms-enum: name: HubBgpConnectionStatus modelAsString: true description: Properties of the bgp connection. ClusterInstanceViewStatus: type: object description: Status of the instance view. required: - ready properties: ready: type: string description: The cluster ready status reason: type: string description: The status reason. message: type: string description: The additional message. 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. TagsResource_5: properties: tags: additionalProperties: type: string description: Resource tags description: A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance. SparkMetastoreSpec: type: object description: The metastore specification for Spark cluster. required: - dbServerHost - dbName - dbUserName - dbPasswordSecretName - keyVaultId properties: dbServerHost: type: string description: The database server host. dbName: type: string description: The database name. dbUserName: type: string description: The database user name. dbPasswordSecretName: type: string description: The secret name which contains the database user password. keyVaultId: type: string description: The key vault resource id. thriftUrl: type: string description: The thrift url. SemanticSearch: type: string enum: - disabled - free - standard x-ms-enum: name: SearchSemanticSearch modelAsString: true values: - value: disabled name: disabled description: Indicates that semantic search is disabled for the search service. This is the default. - value: free name: free description: Enables semantic search on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic search requests and is offered at no extra charge. - value: standard name: standard description: Enables semantic search on a search service as a billable feature, with higher throughput and volume of semantic search queries. description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. VpnServerConfigVpnClientRevokedCertificate: properties: name: type: string description: The certificate name. thumbprint: type: string description: The revoked VPN client certificate thumbprint. description: Properties of the revoked VPN client certificate of VpnServerConfiguration. VideoFlags: properties: canStream: type: boolean description: Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed. hasData: type: boolean description: Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false. isInUse: type: boolean description: Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time. type: object required: - canStream - hasData - isInUse description: Video flags contain information about the available video actions and its dynamic properties based on the current video state. StorageApplianceSkuProperties: type: object title: StorageApplianceSkuProperties represents the properties of the storage appliance SKU. properties: capacityGB: description: The maximum capacity of the storage appliance. type: integer format: int64 readOnly: true model: description: The model of the storage appliance. type: string readOnly: true StreamingPolicyProperties: properties: created: type: string format: date-time description: Creation time of Streaming Policy readOnly: true x-nullable: false defaultContentKeyPolicyName: type: string description: Default ContentKey used by current Streaming Policy envelopeEncryption: $ref: '#/definitions/EnvelopeEncryption' description: Configuration of EnvelopeEncryption commonEncryptionCenc: $ref: '#/definitions/CommonEncryptionCenc' description: Configuration of CommonEncryptionCenc commonEncryptionCbcs: $ref: '#/definitions/CommonEncryptionCbcs' description: Configuration of CommonEncryptionCbcs noEncryption: $ref: '#/definitions/NoEncryption' description: Configurations of NoEncryption type: object description: Class to specify properties of Streaming Policy Volume_2: type: object title: Volume represents storage made available for use by resources running on the cluster. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/VolumeProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true TargetServiceBase: description: The target service properties discriminator: type type: object properties: type: description: The target service type. $ref: '#/definitions/TargetServiceType' required: - type AuthMode: description: Indicates how to apply the authentication configuration operations. type: string enum: - optInAllAuth - optOutAllAuth x-ms-enum: name: authMode modelAsString: true values: - value: optInAllAuth description: Default authentication configuration according to the authentication type. - value: optOutAllAuth description: Skip all authentication configuration such as enabling managed identity and granting RBAC roles ContainerAttachResponse: description: The information for the output stream from container attach. type: object properties: webSocketUri: type: string description: The uri for the output stream from the attach. password: type: string description: The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri. x-ms-secret: true DeviceCapabilityDetails: description: Device capability details for a given sku for a given region. type: object properties: hardwareEncryption: description: Hardware encryption support for a given sku for a given region. enum: - Enabled - Disabled type: string readOnly: true x-ms-enum: name: HardwareEncryption modelAsExtensible: true values: - value: Enabled description: Hardware-based encryption is enabled. - value: Disabled description: Hardware-based encryption is disabled. TrunkedNetworkProperties: type: object title: TrunkedNetworkProperties represents properties of the trunked network. required: - isolationDomainIds - vlans properties: associatedResourceIds: description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. type: array items: type: string readOnly: true clusterId: description: The resource ID of the Network Cloud cluster this trunked network is associated with. type: string format: arm-id readOnly: true detailedStatus: description: The more detailed status of the trunked network. type: string enum: - Error - Available - Provisioning x-ms-enum: modelAsString: true name: TrunkedNetworkDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true hybridAksClustersAssociatedIds: description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network. type: array items: type: string readOnly: true hybridAksPluginType: description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS. type: string default: SRIOV enum: - DPDK - SRIOV - OSDevice x-ms-enum: modelAsString: true name: HybridAksPluginType x-ms-mutability: - read - create interfaceName: description: The default interface name for this trunked network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. type: string maxLength: 12 pattern: ^[a-zA-Z0-9@._-]*$ x-ms-mutability: - read - create isolationDomainIds: description: The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources. type: array minItems: 1 items: type: string x-ms-mutability: - read - create provisioningState: description: The provisioning state of the trunked network. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted x-ms-enum: modelAsString: true name: TrunkedNetworkProvisioningState readOnly: true virtualMachinesAssociatedIds: description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this trunked network. type: array items: type: string readOnly: true vlans: description: The list of vlans that are selected from the isolation domains for trunking. type: array minItems: 1 items: type: integer format: int64 x-ms-mutability: - read - create ContainerState_2: description: The container state. type: object properties: state: type: string description: The state of this container startTime: type: string format: date-time description: Date/time when the container state started. exitCode: type: string description: The container exit code. finishTime: type: string format: date-time description: Date/time when the container state finished. detailStatus: description: Human-readable status of this state. type: string AgentPoolList: type: object title: AgentPoolList represents a list of Kubernetes cluster agent pools. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of agent pools. type: array items: $ref: '#/definitions/AgentPool' CheckNameAvailabilityParameters: description: Details of check name availability request body. type: object properties: name: type: string description: Name for checking availability. type: type: string default: Microsoft.Quantum/Workspaces description: The resource type of Quantum Workspace. ClusterInstanceViewProperties: type: object description: Cluster Instance View Properties. required: - status - serviceStatuses properties: status: description: Status of the instance view. allOf: - $ref: '#/definitions/ClusterInstanceViewStatus' serviceStatuses: type: array description: List of statuses of relevant services that make up the HDInsight on aks cluster to surface to the customer. items: $ref: '#/definitions/ServiceStatus' x-ms-identifiers: [] AzureBareMetalInstancesListResult: properties: value: type: array items: $ref: '#/definitions/AzureBareMetalInstance' description: The list of Azure BareMetal instances. nextLink: type: string description: The URL to get the next set of AzureBareMetal instances. description: The response from the List AzureBareMetal Instances operation. PrivateLinkServiceConnection: description: Private link service connection details. type: object properties: name: description: Private link service connection name. type: string groupIds: description: List of group IDs. type: array items: type: string requestMessage: description: Request message. type: string OsDisk: type: object title: OsDisk represents configuration of the boot disk. required: - diskSizeGB properties: createOption: description: The strategy for creating the OS disk. type: string default: Ephemeral enum: - Ephemeral x-ms-enum: modelAsString: true name: OsDiskCreateOption deleteOption: description: The strategy for deleting the OS disk. type: string default: Delete enum: - Delete x-ms-enum: modelAsString: true name: OsDiskDeleteOption diskSizeGB: description: The size of the disk in gigabytes. Required if the createOption is Ephemeral. type: integer format: int64 ActionType: description: Indicates how to apply the connector operations, such as opt out network configuration, opt in configuration. type: string enum: - enable - optOut x-ms-enum: name: actionType modelAsString: true ConnectionError: type: object properties: connectionState: description: The kind of connection error that occurred. type: string enum: - Unknown - OK - OperatorToDataCenterNetworkError - DatacenterToDatacenterNetworkError - InternalOperatorToDataCenterCertificateError - InternalError x-ms-enum: name: ConnectionState modelAsString: true iPFrom: description: The IP of host that originated the failed connection. type: string iPTo: description: The IP that the connection attempted to reach. type: string port: description: The TCP port the connection was attempted on. type: integer format: int32 exception: description: Detailed error message about the failed connection. type: string MediaServiceProperties: description: The additional properties of a Media Service resource. properties: apiEndpoints: description: Read-only property that lists the Media Services REST API endpoints for this resource. If supplied on a PUT or PATCH, the value will be ignored. readOnly: true type: array items: $ref: '#/definitions/ApiEndpoint' storageAccounts: description: The storage accounts for this resource. type: array items: $ref: '#/definitions/StorageAccount_2' HiveCatalogOption: type: object description: Hive Catalog Option required: - catalogName - metastoreDbConnectionURL - metastoreDbConnectionUserName - metastoreDbConnectionPasswordSecret - metastoreWarehouseDir properties: catalogName: description: Name of trino catalog which should use specified hive metastore. minLength: 1 type: string metastoreDbConnectionPasswordSecret: description: Secret reference name from secretsProfile.secrets containing password for database connection. type: string metastoreDbConnectionURL: description: Connection string for hive metastore database. type: string metastoreDbConnectionUserName: description: User name for database connection. type: string metastoreWarehouseDir: description: 'Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri' type: string VpnServerConfigVpnClientRootCertificate: properties: name: type: string description: The certificate name. publicCertData: type: string description: The certificate public data. description: Properties of VPN client root certificate of VpnServerConfiguration. LinkedStorageAccountsProperties: type: object description: An Application Insights component linked storage account properties: linkedStorageAccount: type: string description: Linked storage account resource ID GroupProperties: type: object description: Properties of group resource. required: - machines properties: machines: type: array description: List of machine names that are part of this group. items: type: string description: Reference to a machine. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/machines/{machineName} assessments: type: array description: List of References to Assessments created on this group. readOnly: true items: type: string description: Reference to an Assessment. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName} readOnly: true createdTimestamp: type: string format: date-time description: Time when this project was created. Date-Time represented in ISO-8601 format. readOnly: true updatedTimestamp: type: string format: date-time description: Time when this project was last updated. Date-Time represented in ISO-8601 format. readOnly: true ListVirtualHubsResult: description: Result of the request to list VirtualHubs. It contains a list of VirtualHubs and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VirtualHub' description: List of VirtualHubs. nextLink: type: string description: URL to get the next set of operation list results if there are any. KubernetesClusterPatchProperties: type: object title: KubernetesClusterPatchProperties represents the properties of the Kubernetes cluster that can be patched. properties: administratorConfiguration: $ref: '#/definitions/AdministratorConfigurationPatch' description: The configuration of the default administrator credentials. controlPlaneNodeConfiguration: $ref: '#/definitions/ControlPlaneNodePatchConfiguration' description: The defining characteristics of the control plane that can be patched for this Kubernetes cluster. kubernetesVersion: description: The Kubernetes version for this cluster. Accepts n.n, n.n.n, and n.n.n-n format. The interpreted version used will be resolved into this field after creation or update. type: string ListVpnServerConfigurationPolicyGroupsResult: type: object description: Result of the request to list VpnServerConfigurationPolicyGroups. It contains a list of VpnServerConfigurationPolicyGroups and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' description: List of VpnServerConfigurationPolicyGroups. nextLink: type: string description: URL to get the next set of operation list results if there are any. ItsmReceiver: description: An Itsm receiver. type: object properties: name: type: string description: The name of the Itsm receiver. Names must be unique across all receivers within an action group. workspaceId: type: string description: OMS LA instance identifier. connectionId: type: string description: Unique identification of ITSM connection among multiple defined in above workspace. ticketConfiguration: type: string description: JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well. region: type: string description: Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' required: - name - workspaceId - connectionId - ticketConfiguration - region ServiceReplicaProperties: description: Describes the properties of a service replica. type: object properties: osType: type: string description: 'The Operating system type required by the code in service. ' enum: - Linux - Windows x-ms-enum: name: OperatingSystemTypes modelAsString: true codePackages: description: 'Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). ' type: array items: $ref: '#/definitions/ContainerCodePackageProperties' networkRefs: type: array description: The names of the private networks that this service needs to be part of. items: $ref: '#/definitions/NetworkRef' diagnostics: $ref: '#/definitions/DiagnosticsRef' description: Reference to sinks in DiagnosticsDescription. required: - osType - codePackages RemediationListResult: description: List of remediations. properties: value: description: Array of remediation definitions. type: array items: $ref: '#/definitions/Remediation' readOnly: true nextLink: type: string description: The URL to get the next set of results. readOnly: true RoutingState: type: string description: The current routing state of the VirtualHub. readOnly: true enum: - None - Provisioned - Provisioning - Failed x-ms-enum: name: RoutingState modelAsString: true NetworkAdapter: type: object description: A network adapter discovered on a machine. properties: macAddress: type: string description: MAC Address of the network adapter. readOnly: true ipAddresses: type: array description: List of IP Addresses on the network adapter. readOnly: true items: type: string description: IP Address of the network adapter. readOnly: true TargetDescription: type: object description: Information about a Target. A target is the component that can process a specific type of Job. properties: id: type: string description: Unique target id. name: type: string description: Display name of this target. description: type: string description: A description about this target. acceptedDataFormats: type: array description: List of data formats accepted by this target. items: type: string acceptedContentEncodings: type: array description: List of content encodings accepted by this target. items: type: string eventsSessionInfo: description: Session info for an event result type: object properties: id: description: ID of the session type: string eventsResults: description: An events query result. type: object properties: '@odata.context': description: OData context metadata endpoint for this response type: string '@ai.messages': description: OData messages for this response. type: array items: $ref: '#/definitions/errorInfo' value: description: Contents of the events query result. type: array items: $ref: '#/definitions/eventsResultData' AdministratorConfigurationPatch: type: object title: AdministratorConfigurationPatch represents the patching capabilities for the administrator configuration. properties: sshPublicKeys: description: SshPublicKey represents the public key used to authenticate with a resource through SSH. type: array items: $ref: '#/definitions/SshPublicKey' x-ms-identifiers: - keyData Azure.Core.Foundations.ErrorResponse: type: object description: A response containing error details. properties: error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: The error object. required: - error DocumentProcessorList: type: object description: Document processor list properties: value: description: Array of document processors. type: array items: $ref: '#/definitions/DocumentProcessorResource' readOnly: true nextLink: description: Link to retrieve next page of results. type: string readOnly: true AppRoleAssignmentHealthReportList: description: List of AppRoleAssignment health reports for the application. properties: value: type: array description: A report of the health status of an AppRoleAssignment. items: $ref: '#/definitions/AppRoleAssignmentHealthReport' x-ms-identifiers: - appRoleAssignment/resource nextLink: description: URI to the next page. type: string RackList: type: object title: RackList represents a list of racks. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of racks. type: array items: $ref: '#/definitions/Rack' StreamingPolicyPlayReadyConfiguration: properties: customLicenseAcquisitionUrlTemplate: type: string description: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. playReadyCustomAttributes: type: string description: Custom attributes for PlayReady type: object description: Class to specify configurations of PlayReady in Streaming Policy ClusterJobList: description: Collection of cluster job. type: object required: - value properties: value: type: array description: Collection of cluster job. uniqueItems: false items: $ref: '#/definitions/ClusterJob' x-ms-identifiers: [] nextLink: description: The Url of next result page. type: string CloudErrorBody_8: x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. 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_8' description: A list of additional details about the error. description: An error response from the service. SecretVolume: description: The secret volume. type: object additionalProperties: type: string SshPublicKey: type: object title: SshPublicKey represents the public key used to authenticate with a resource through SSH. required: - keyData properties: keyData: description: The SSH public key data. type: string minLength: 1 ArcAgentProfile: description: Defines the Arc Agent properties for the clusters. type: object properties: desiredAgentVersion: type: string description: Version of the Arc agents to be installed on the cluster resource agentAutoUpgrade: type: string description: Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled. default: Enabled enum: - Enabled - Disabled x-ms-enum: name: AutoUpgradeOptions modelAsString: true ThroughputPoolAccountResource: description: An Azure Cosmos DB Throughputpool Account type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ThroughputPoolAccountProperties' allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource VirtualWAN: required: - location properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VirtualWanProperties' description: Properties of the virtual WAN. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. allOf: - $ref: ./network.json#/definitions/Resource description: VirtualWAN Resource. NetworkDependenciesResponse: description: Response for network dependencies, always empty list. type: array items: type: string OldAgreementProperties: type: object properties: id: type: string description: A unique identifier of the agreement. publisher: type: string description: Publisher identifier string of image being deployed. offer: type: string description: Offer identifier string of image being deployed. signDate: type: string format: date-time description: Date and time in UTC of when the terms were accepted. This is empty if state is cancelled. cancelDate: type: string format: date-time description: Date and time in UTC of when the terms were cancelled. This is empty if state is active. state: type: string enum: - Active - Canceled description: Whether the agreement is active or cancelled x-ms-enum: name: state modelAsString: true description: Old Agreement Terms definition VideoArchival: properties: retentionPeriod: type: string description: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours. type: object description: Video archival properties. PublicNetworkSolution: type: object description: Indicates public network solution, include firewall rules properties: deleteOrUpdateBehavior: description: Indicates whether to clean up previous operation(such as firewall rules) when Linker is updating or deleting $ref: '#/definitions/DeleteOrUpdateBehavior' action: description: Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration. $ref: '#/definitions/ActionType' firewallRules: description: Describe firewall rules of target service to make sure source application could connect to the target. $ref: '#/definitions/FirewallRules' MoveCollectionProperties: description: Defines the move collection properties. type: object required: - sourceRegion - targetRegion properties: sourceRegion: description: Gets or sets the source region. type: string targetRegion: description: Gets or sets the target region. type: string provisioningState: $ref: '#/definitions/ProvisioningState_4' errors: description: Defines the move collection errors. allOf: - $ref: '#/definitions/MoveResourceError' readOnly: true Group: type: object x-ms-azure-resource: true description: A group created in a Migration project. required: - properties properties: id: description: Path reference to this group. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName} type: string readOnly: true name: description: Name of the group. type: string readOnly: true eTag: type: string description: For optimistic concurrency control. type: type: string description: Type of the object = [Microsoft.Migrate/projects/groups]. readOnly: true properties: description: Properties of the group. x-ms-client-flatten: true $ref: '#/definitions/GroupProperties' TrinoDebugConfig: type: object description: Trino debug configuration. properties: enable: type: boolean description: The flag that if enable debug or not. default: false port: type: integer format: int32 description: The debug port. default: 8008 suspend: type: boolean description: The flag that if suspend debug or not. default: false ExtensionVersionList: description: List versions for an Extension type: object properties: versions: description: Versions available for this Extension Type type: array items: type: object properties: releaseTrain: description: The release train for this Extension Type type: string versions: type: array description: Versions available for this Extension Type and release train items: type: string nextLink: description: The link to fetch the next page of Extension Types type: string systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData readOnly: true description: Metadata pertaining to creation and last modification of the resource. LogAnalyticsQueryPack: properties: properties: x-ms-client-flatten: true description: Properties that define a Log Analytics QueryPack resource. $ref: '#/definitions/LogAnalyticsQueryPackProperties' allOf: - $ref: '#/definitions/QueryPacksResource' required: - properties description: An Log Analytics QueryPack definition. RouteMapActionType: type: string description: Kind of actions which can be taken on a matched route. Add, Replace, Remove refer to parameters on the route, like community or prefix enum: - Unknown - Remove - Add - Replace - Drop x-ms-enum: name: RouteMapActionType modelAsString: true CloudHsmClusterError: properties: error: $ref: '#/definitions/CHsmError' description: The Cloud HSM Cluster error details type: object ImageRepositoryCredentials: type: object title: ImageRepositoryCredentials represents the credentials used to login to the image repository. required: - username - password - registryUrl properties: password: description: The password or token used to access an image in the target repository. type: string minLength: 1 x-ms-secret: true registryUrl: description: The URL of the authentication server used to validate the repository credentials. type: string username: description: The username used to access an image in the target repository. type: string minLength: 1 GitHubConnectorListResponse: type: object properties: value: description: Gets or sets list of resources. type: array items: $ref: '#/definitions/GitHubConnector' x-ms-identifiers: [] nextLink: description: Gets or sets next link to scroll over the results. type: string ScalingProperties: type: object description: Properties for Scaling properties: serverCount: description: Required management server count type: integer format: int64 maximum: 100 minimum: 1 Usage: description: A single usage result type: object properties: id: readOnly: true type: string description: Id of the usage result unit: readOnly: true type: string description: Unit of the usage result currentValue: readOnly: true type: integer format: int32 description: The current usage of the resource limit: readOnly: true type: integer format: int32 description: The maximum permitted usage of the resource. name: readOnly: true type: object description: The name object of the resource properties: value: readOnly: true type: string description: The name of the resource localizedValue: readOnly: true type: string description: The localized name of the resource eventType: description: The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. type: string enum: - $all - traces - customEvents - pageViews - browserTimings - requests - dependencies - exceptions - availabilityResults - performanceCounters - customMetrics x-ms-enum: name: EventType modelAsString: true VirtualMachineProperties: type: object title: VirtualMachineProperties represents the properties of the virtual machine. required: - vmImage - cpuCores - memorySizeGB - storageProfile - cloudServicesNetworkAttachment - adminUsername properties: adminUsername: description: The name of the administrator to which the ssh public keys will be added into the authorized keys. type: string maxLength: 32 minLength: 1 pattern: ^[a-z_][a-z0-9_]{0,31}$ x-ms-mutability: - read - create availabilityZone: description: The cluster availability zone containing this virtual machine. type: string readOnly: true bareMetalMachineId: description: The resource ID of the bare metal machine that hosts the virtual machine. type: string format: arm-id readOnly: true bootMethod: description: Selects the boot method for the virtual machine. type: string default: UEFI enum: - UEFI - BIOS x-ms-enum: modelAsString: true name: VirtualMachineBootMethod x-ms-mutability: - read - create cloudServicesNetworkAttachment: $ref: '#/definitions/NetworkAttachment' description: The cloud service network that provides platform-level services for the virtual machine. x-ms-mutability: - read - create clusterId: description: The resource ID of the cluster the virtual machine is created for. type: string format: arm-id readOnly: true cpuCores: description: The number of CPU cores in the virtual machine. type: integer format: int64 minimum: 2 x-ms-mutability: - read - create detailedStatus: description: The more detailed status of the virtual machine. type: string enum: - Available - Error - Provisioning - Running - Scheduling - Stopped - Terminating - Unknown x-ms-enum: modelAsString: true name: VirtualMachineDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true isolateEmulatorThread: description: Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. type: string default: 'True' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: VirtualMachineIsolateEmulatorThread x-ms-mutability: - read - create memorySizeGB: description: The memory size of the virtual machine in GB. type: integer format: int64 minimum: 1 x-ms-mutability: - read - create networkAttachments: description: The list of network attachments to the virtual machine. type: array items: $ref: '#/definitions/NetworkAttachment' x-ms-identifiers: [] x-ms-mutability: - read - create networkData: description: The Base64 encoded cloud-init network data. type: string x-ms-mutability: - read - create placementHints: description: The scheduling hints for the virtual machine. type: array items: $ref: '#/definitions/VirtualMachinePlacementHint' x-ms-identifiers: [] x-ms-mutability: - read - create powerState: description: The power state of the virtual machine. type: string enum: - 'On' - 'Off' - Unknown x-ms-enum: modelAsString: true name: VirtualMachinePowerState readOnly: true provisioningState: description: The provisioning state of the virtual machine. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted x-ms-enum: modelAsString: true name: VirtualMachineProvisioningState readOnly: true sshPublicKeys: description: The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. type: array items: $ref: '#/definitions/SshPublicKey' x-ms-identifiers: [] x-ms-mutability: - read - create storageProfile: $ref: '#/definitions/StorageProfile_2' description: The storage profile that specifies size and other parameters about the disks related to the virtual machine. x-ms-mutability: - read - create userData: description: The Base64 encoded cloud-init user data. type: string x-ms-mutability: - read - create virtioInterface: description: Field Deprecated, use virtualizationModel instead. The type of the virtio interface. type: string default: Modern enum: - Modern - Transitional x-ms-enum: modelAsString: true name: VirtualMachineVirtioInterfaceType x-ms-mutability: - read - create vmDeviceModel: description: The type of the device model to use. type: string default: T2 enum: - T1 - T2 x-ms-enum: modelAsString: true name: VirtualMachineDeviceModelType x-ms-mutability: - read - create vmImage: description: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. type: string x-ms-mutability: - read - create vmImageRepositoryCredentials: $ref: '#/definitions/ImageRepositoryCredentials' description: The credentials used to login to the image repository that has access to the specified image. volumes: description: The resource IDs of volumes that are attached to the virtual machine. type: array items: type: string readOnly: true SystemData: description: Read only system data type: object readOnly: true properties: createdBy: type: string description: The identity that created the resource. createdByType: $ref: '#/definitions/IdentityType' description: The type of identity that created the resource createdAt: type: string format: date-time description: The timestamp of resource creation (UTC) lastModifiedBy: type: string description: The identity that last modified the resource. lastModifiedByType: $ref: '#/definitions/IdentityType' description: The type of identity that last modified the resource lastModifiedAt: type: string format: date-time description: The timestamp of resource last modification (UTC) VpnSiteLinkConnection: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnSiteLinkConnectionProperties' description: Properties of the VPN site link connection. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. type: readOnly: true type: string description: Resource type. allOf: - $ref: ./network.json#/definitions/SubResource description: VpnSiteLinkConnection Resource. ErrorInfo: title: The code and message for an error. type: object properties: code: description: A machine readable error code. type: string message: description: A human readable error message. type: string details: description: error details. type: array items: $ref: '#/definitions/ErrorDetail' innererror: description: Inner error details if they exist. $ref: '#/definitions/ErrorInfo' additionalProperties: description: Additional properties that can be provided on the error info object type: object required: - code - message UserIdentity: description: Azure Active Directory identity configuration for a resource. type: object properties: principalId: description: The Azure Active Directory principal id. type: string readOnly: true clientId: description: The Azure Active Directory client id. type: string readOnly: true RebootRequirement: type: string enum: - Unknown - 'True' - 'False' x-ms-enum: name: RebootRequirement modelAsString: true AksClusterProfile: type: object description: Properties of the cluster pool underlying AKS cluster. properties: aksClusterResourceId: type: string description: ARM Resource ID of the AKS cluster format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.ContainerService/managedClusters aksClusterAgentPoolIdentityProfile: description: Identity properties of the AKS cluster agentpool MSI allOf: - $ref: '#/definitions/IdentityProfile' aksVersion: type: string description: AKS control plane and default node pool version of this ClusterPool readOnly: true CsmMoveResourceEnvelope: description: Object with a list of the resources that need to be moved and the resource group they should be moved to. type: object properties: targetResourceGroup: maxLength: 90 minLength: 1 pattern: ' ^[-\w\._\(\)]+[^\.]$' type: string resources: type: array items: type: string VnetValidationFailureDetails: description: A class that describes the reason for a validation failure. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: VnetValidationFailureDetails resource specific properties type: object properties: message: description: Text describing the validation outcome. type: string failed: description: A flag describing whether or not validation failed. type: boolean failedTests: description: A list of tests that failed in the validation. type: array items: $ref: '#/definitions/VnetValidationTestFailure' warnings: description: A list of warnings generated during validation. type: array items: $ref: '#/definitions/VnetValidationTestFailure' x-ms-client-flatten: true O365PolicyProperties: properties: breakOutCategories: readOnly: false description: Office365 breakout categories. $ref: '#/definitions/O365BreakOutCategoryPolicies' description: The Office365 breakout policy. HealthState_3: title: One of health states - healthy, critical, warning, unknown, none, disabled. type: string readOnly: true enum: - Healthy - Critical - Warning - Unknown - Disabled - None x-ms-enum: name: HealthState modelAsString: true AzureDevOpsConnectorStatsProperties: type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState_3' orgsCount: format: int64 description: Gets or sets orgs count. type: integer projectsCount: format: int64 description: Gets or sets projects count. type: integer reposCount: format: int64 description: Gets or sets repos count. type: integer IpAddress: properties: ipAddress: type: string description: Specifies the IP address of the network interface. description: Specifies the IP address of the network interface. Capabilities: description: The regional capabilities. type: object properties: resourceType: type: string readOnly: true description: The resource type that this capability describes. osType: type: string readOnly: true description: The OS type that this capability describes. location: type: string readOnly: true description: The resource location. ipAddressType: type: string readOnly: true description: The ip address type that this capability describes. gpu: type: string readOnly: true description: The GPU sku that this capability describes. capabilities: type: object readOnly: true description: The supported capabilities. properties: maxMemoryInGB: type: number readOnly: true description: The maximum allowed memory request in GB. maxCpu: type: number readOnly: true description: The maximum allowed CPU request in cores. maxGpuCount: type: number readOnly: true description: The maximum allowed GPU count. pipelineConnection: description: Connection body inside a pipeline type: object properties: id: type: string description: Connection id inside pipeline name: type: string description: Connection name inside pipeline readOnly: true type: type: string description: Connection type inside pipeline readOnly: true location: type: string description: Connection location inside pipeline x-ms-mutability: - read readOnly: true etag: type: string description: Connection etag inside pipeline readOnly: true systemData: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/systemData properties: type: object description: Connection properties inside pipeline properties: internalMetadata: $ref: '#/definitions/internalMetadataProperties' additionalProperties: {} additionalProperties: {} required: - id CapacitySku: description: Represents the SKU name and Azure pricing tier for PowerBI Dedicated capacity resource. type: object properties: name: type: string description: Name of the SKU level. tier: type: string enum: - PBIE_Azure - Premium - AutoPremiumHost x-ms-enum: name: CapacitySkuTier modelAsString: true description: The name of the Azure pricing tier to which the SKU applies. capacity: type: integer format: int32 description: The capacity of the SKU. required: - name AzureDevOpsOrgListResponse: type: object properties: value: description: Gets or sets list of resources. type: array items: $ref: '#/definitions/AzureDevOpsOrg' x-ms-identifiers: [] nextLink: description: Gets or sets next link to scroll over the results. type: string VolumeMount: description: The properties of the volume mount. type: object required: - name - mountPath properties: name: description: The name of the volume mount. type: string mountPath: description: The path within the container where the volume should be mounted. Must not contain colon (:). type: string readOnly: description: The flag indicating whether the volume mount is read-only. type: boolean GroupResultList: type: object description: List of groups. properties: value: type: array description: List of groups. items: $ref: '#/definitions/Group' HealthMonitorStateChange: title: Information about the monitor’s health state change at the provided timestamp. type: object properties: properties: description: Properties of the monitor's state change. x-ms-client-flatten: true $ref: '#/definitions/HealthMonitorStateChangeProperties' allOf: - $ref: '#/definitions/Resource_10' ListRoutingIntentResult: description: List of the routing intent result and a URL nextLink to get the next set of results. type: object properties: value: type: array items: $ref: '#/definitions/RoutingIntent' description: List of RoutingIntent resource. nextLink: type: string description: URL to get the next set of operation list results if there are any. Context: description: The context info type: object properties: notificationSource: type: string description: The source of the notification request contextType: type: string description: The context id type Schedule: type: object description: Schedule definition. required: - days - startTime - endTime - count properties: startTime: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$ description: User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). endTime: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$ description: User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). count: type: integer format: int32 description: User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. days: type: array description: User has to set the days where schedule has to be set for autoscale operation. items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday x-ms-enum: name: ScheduleDay modelAsString: true ErrorDetail_3: required: - code - message type: object properties: code: type: string message: type: string details: type: array items: $ref: '#/definitions/Details' target: type: string ErrorResponse_5: description: Describes the format of Error response. type: object properties: error: type: object description: The error object properties: code: description: Error code type: string message: description: Error message indicating why the operation failed. type: string details: readOnly: true type: array items: $ref: '#/definitions/ErrorDetail_2' description: The error details. VirtualHubRoute: properties: addressPrefixes: type: array description: List of all addressPrefixes. items: type: string nextHopIpAddress: type: string description: NextHop ip address. description: VirtualHub route. CloudHsmClusterSecurityDomainProperties: type: object description: Security domain properties information for Cloud HSM cluster properties: fipsState: format: int32 type: integer description: FIPS state information for security domain activationStatus: type: string description: status of security domain activation HubVirtualNetworkConnectionProperties: properties: remoteVirtualNetwork: $ref: ./network.json#/definitions/SubResource description: Reference to the remote virtual network. allowHubToRemoteVnetTransit: type: boolean description: 'Deprecated: VirtualHub to RemoteVnet transit to enabled or not.' allowRemoteVnetToUseHubVnetGateways: type: boolean description: 'Deprecated: Allow RemoteVnet to use Virtual Hub''s gateways.' enableInternetSecurity: type: boolean description: Enable internet security. routingConfiguration: $ref: '#/definitions/RoutingConfiguration' description: The Routing Configuration indicating the associated and propagated route tables on this connection. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the hub virtual network connection resource. description: Parameters for HubVirtualNetworkConnection. ExtendedLocation: type: object title: ExtendedLocation represents the Azure custom location where the resource will be created. required: - type - name properties: name: description: The resource ID of the extended location on which the resource will be created. type: string x-ms-mutability: - read - create type: description: The extended location type, for example, CustomLocation. type: string x-ms-mutability: - read - create HybridComputePrivateLinkScopeListResult: type: object description: Describes the list of Azure Arc PrivateLinkScope resources. required: - value properties: value: type: array description: List of Azure Arc PrivateLinkScope definitions. items: $ref: '#/definitions/HybridComputePrivateLinkScope' nextLink: type: string description: The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set. TagsResource: properties: tags: additionalProperties: type: string description: Resource tags description: A container holding only the Tags for a resource, allowing the user to update the tags on a WebTest instance. NetworkVirtualApplianceConnectionProperties: type: object properties: name: type: string description: The name of the resource. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the NetworkVirtualApplianceConnection resource. asn: type: integer readOnly: false format: int64 minimum: 0 maximum: 4294967295 description: Network Virtual Appliance ASN. tunnelIdentifier: type: integer readOnly: false format: int64 minimum: 0 maximum: 4294967295 description: Unique identifier for the connection. bgpPeerAddress: type: array items: type: string description: List of bgpPeerAddresses for the NVA instances enableInternetSecurity: type: boolean description: Enable internet security. routingConfiguration: $ref: '#/definitions/RoutingConfiguration' description: The Routing Configuration indicating the associated and propagated route tables on this connection. description: Properties of the NetworkVirtualApplianceConnection subresource. ErrorDefinition_2: type: object title: Error description: Error description and code explaining why an operation failed. required: - message - code properties: message: type: string description: Description of the error. code: type: string description: Service specific error code which serves as the substatus for the HTTP error code. StorageProfile: properties: nfsIpAddress: readOnly: true type: string description: IP Address to connect to storage. osDisks: type: array items: $ref: '#/definitions/Disk_2' x-ms-identifiers: - name description: Specifies information about the operating system disk used by baremetal instance. description: Specifies the storage settings for the AzureBareMetal instance disks. ThroughputPoolsListResult: description: The List operation response, that contains the throughput pools and their properties. type: object properties: value: description: List of throughput pools and their properties. readOnly: true type: array items: $ref: '#/definitions/ThroughputPoolResource' nextLink: description: The link used to get the next page of results. type: string readOnly: true BareMetalMachineRunCommandParameters: type: object title: BareMetalMachineRunCommandParameters represents the body of the request to execute a script on the bare metal machine. required: - script - limitTimeSeconds properties: arguments: description: The list of string arguments that will be passed to the script in order as separate arguments. type: array items: type: string limitTimeSeconds: description: 'The maximum time the script is allowed to run. If the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).' type: integer format: int64 maximum: 14400 minimum: 60 script: description: The base64 encoded script to execute on the bare metal machine. type: string Resource_6: properties: id: type: string readOnly: true description: Azure resource Id name: type: string readOnly: true description: Azure resource name type: type: string readOnly: true description: Azure resource type location: type: string description: Resource location x-ms-mutability: - create - read tags: additionalProperties: type: string description: Resource tags required: - location x-ms-azure-resource: true description: An azure resource object CloudError: x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody' description: An error response from the Batch service. setServerCountResponseProperties: type: object description: Properties for set server count operation properties: serverCount: description: Management server count type: integer format: int64 TagsObject: properties: tags: type: object additionalProperties: type: string description: Resource tags. description: Tags object for patch operations. BmcKeySetPatchProperties: type: object title: BmcKeySetPatchProperties represents the properties of baseboard management controller key set that are patchable. properties: expiration: description: The date and time after which the users in this key set will be removed from the baseboard management controllers. type: string format: date-time userList: description: The unique list of permitted users. type: array items: $ref: '#/definitions/KeySetUser' x-ms-identifiers: - azureUserName VideoAnalyzerCollection: properties: value: type: array items: $ref: '#/definitions/VideoAnalyzer' description: A collection of VideoAnalyzer items. type: object description: A collection of VideoAnalyzer items. Error_2: properties: error: type: object description: The error object. properties: code: readOnly: true type: string description: The error code. message: readOnly: true type: string description: The error message. target: readOnly: true type: string description: The error target. details: readOnly: true type: array items: $ref: '#/definitions/Error_2' description: The error details. additionalInfo: readOnly: true type: array items: $ref: '#/definitions/ErrorAdditionalInfo_3' description: The error additional info. description: The resource management error response. ClusterLogAnalyticsProfile: type: object description: Cluster log analytics profile to enable or disable OMS agent for cluster. required: - enabled properties: enabled: type: boolean description: True if log analytics is enabled for the cluster, otherwise false. applicationLogs: $ref: '#/definitions/ClusterLogAnalyticsApplicationLogs' metricsEnabled: type: boolean description: True if metrics are enabled, otherwise false. ComponentPolicyState: type: object description: Component Policy State record. properties: '@odata.id': description: OData entity ID; always set to null since component policy state records do not have an entity ID. type: string readOnly: true '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string readOnly: true timestamp: description: Timestamp for the component policy state record. type: string format: date-time readOnly: true componentId: description: Component Id. type: string readOnly: true componentType: description: Component type. type: string readOnly: true componentName: description: Component name. type: string readOnly: true resourceId: description: Resource ID. type: string readOnly: true policyAssignmentId: description: Policy assignment ID. type: string readOnly: true policyDefinitionId: description: Policy definition ID. type: string readOnly: true subscriptionId: description: Subscription ID. type: string readOnly: true resourceType: description: Resource type. type: string readOnly: true resourceLocation: description: Resource location. type: string readOnly: true resourceGroup: description: Resource group name. type: string readOnly: true policyAssignmentName: description: Policy assignment name. type: string readOnly: true policyAssignmentOwner: description: Policy assignment owner. type: string readOnly: true policyAssignmentParameters: description: Policy assignment parameters. type: string readOnly: true policyAssignmentScope: description: Policy assignment scope. type: string readOnly: true policyDefinitionName: description: Policy definition name. type: string readOnly: true policyDefinitionAction: description: Policy definition action, i.e. effect. type: string readOnly: true policyDefinitionCategory: description: Policy definition category. type: string readOnly: true policySetDefinitionId: description: Policy set definition ID, if the policy assignment is for a policy set. type: string readOnly: true policySetDefinitionName: description: Policy set definition name, if the policy assignment is for a policy set. type: string readOnly: true policySetDefinitionOwner: description: Policy set definition owner, if the policy assignment is for a policy set. type: string readOnly: true policySetDefinitionCategory: description: Policy set definition category, if the policy assignment is for a policy set. type: string readOnly: true policySetDefinitionParameters: description: Policy set definition parameters, if the policy assignment is for a policy set. type: string readOnly: true policyDefinitionReferenceId: description: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set. type: string readOnly: true complianceState: description: Compliance state of the resource. type: string readOnly: true policyEvaluationDetails: description: Policy evaluation details. This is only included in the response if the request contains $expand=PolicyEvaluationDetails. type: object $ref: '#/definitions/ComponentPolicyEvaluationDetails' policyDefinitionGroupNames: description: Policy definition group names. type: array items: type: string readOnly: true policyDefinitionVersion: description: Evaluated policy definition version. type: string readOnly: true policySetDefinitionVersion: description: Evaluated policy set definition version. type: string readOnly: true policyAssignmentVersion: description: Evaluated policy assignment version. type: string readOnly: true additionalProperties: description: The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated Tags: description: Resource tags. type: object readOnly: false additionalProperties: type: string AzureDevOpsConnectorStats: type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/AzureDevOpsConnectorStatsProperties' L3NetworkPatchParameters: type: object title: L3NetworkPatchParameters represents the body of the request to patch the cloud services network. properties: tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string IpAddressPool: type: object title: IpAddressPool represents a pool of IP addresses that can be allocated to a service. required: - addresses - name properties: addresses: description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. type: array items: type: string x-ms-mutability: - read - create autoAssign: description: The indicator to determine if automatic allocation from the pool should occur. type: string default: 'True' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: BfdEnabled x-ms-mutability: - read - create name: description: The name used to identify this IP address pool for association with a BGP advertisement. type: string pattern: ^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$ x-ms-mutability: - read - create onlyUseHostIps: description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. type: string default: 'True' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: BfdEnabled x-ms-mutability: - read - create AdditionalErrorInfo: description: This class represents additional info which Resource Providers pass when an error occurs. properties: info: description: Additional information of the type of error. type: object type: description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). type: string type: object VideoEntity: allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/VideoProperties' description: The resource properties. x-ms-client-flatten: true type: object description: Represents a video resource within Azure Video Analyzer. Videos can be ingested from RTSP cameras through live pipelines or can be created by exporting sequences from existing captured video through a pipeline job. Videos ingested through live pipelines can be streamed through Azure Video Analyzer Player Widget or compatible players. Exported videos can be downloaded as MP4 files. ContainerGroupIdentity: description: Identity for the container group. properties: principalId: readOnly: true type: string description: The principal id of the container group identity. This property will only be provided for a system assigned identity. tenantId: readOnly: true type: string description: The tenant id associated with the container group. This property will only be provided for a system assigned identity. type: type: string description: The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group. enum: - SystemAssigned - UserAssigned - SystemAssigned, UserAssigned - None x-ms-enum: name: ResourceIdentityType modelAsString: false userAssignedIdentities: type: object description: The list of user identities associated with the container group. additionalProperties: description: 'The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''.' $ref: '#/definitions/UserAssignedIdentities' PublicNetworkAccessType: type: string description: The network access type for operating on the Application Insights Component. By default it is Enabled default: Enabled enum: - Enabled - Disabled x-ms-enum: name: PublicNetworkAccessType modelAsString: true values: - value: Enabled description: Enables connectivity to Application Insights through public DNS. - value: Disabled description: Disables public connectivity to Application Insights through public DNS. StorageApplianceEnableRemoteVendorManagementParameters: type: object title: StorageApplianceEnableRemoteVendorManagementParameters represents the body of the request to enable remote vendor management of a storage appliance. properties: supportEndpoints: description: Field Deprecated. This field is not used and will be rejected if provided. The list of IPv4 subnets (in CIDR format), IPv6 subnets (in CIDR format), or hostnames that the storage appliance needs accessible in order to turn on the remote vendor management. type: array items: type: string pendingFlow: type: object description: Pending flow object properties: subscriptionId: type: string description: Subscription ID of the pending flow. readOnly: true connectionId: type: string description: Connection ID of the pending flow. readOnly: true allOf: - $ref: '#/definitions/flowProperties' - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource ItemDetails: type: object description: A workspace item. properties: id: $ref: '#/definitions/WorkspaceItemId' description: Id of the item. readOnly: true name: type: string description: The name of the item. It is not required for the name to be unique and it's only used for display purposes. x-ms-mutability: - read - update - create providerId: type: string description: The unique identifier for the provider. x-ms-mutability: - read - create target: type: string description: The target identifier to run the job. x-ms-mutability: - read - create itemType: $ref: '#/definitions/ItemType' description: Type of the Quantum Workspace item x-ms-mutability: - read - create creationTime: type: string format: date-time description: The creation time of the item. readOnly: true beginExecutionTime: type: string format: date-time description: The time when the item began execution. readOnly: true endExecutionTime: type: string format: date-time description: The time when the item finished execution. readOnly: true costEstimate: $ref: '#/definitions/CostEstimate' description: Cost estimate. readOnly: true errorData: $ref: '#/definitions/Errors.WorkspaceItemError' description: Error information. readOnly: true discriminator: itemType required: - id - name - providerId - target - itemType Error: type: object properties: error: type: object description: The error object. properties: code: readOnly: true type: string description: The error code. message: readOnly: true type: string description: The error message. target: readOnly: true type: string description: The error target. details: readOnly: true type: array items: $ref: '#/definitions/Error' x-ms-identifiers: [] description: The error details. additionalInfo: readOnly: true type: array items: $ref: '#/definitions/ErrorAdditionalInfo' x-ms-identifiers: [] description: The error additional info. description: The resource management error response. CloudServicesNetworkList: type: object title: CloudServicesNetworkList represents a list of cloud services networks. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of cloud services networks. type: array items: $ref: '#/definitions/CloudServicesNetwork' VideoAnalyzerPropertiesUpdate: properties: storageAccounts: type: array items: $ref: '#/definitions/StorageAccount' description: The storage accounts for this resource. endpoints: type: array items: $ref: '#/definitions/Endpoint' x-ms-identifiers: - endpointUrl description: The endpoints associated with this resource. readOnly: true encryption: $ref: '#/definitions/AccountEncryption' description: The account encryption properties. iotHubs: type: array items: $ref: '#/definitions/IotHub' description: The IoT Hubs for this resource. publicNetworkAccess: type: string enum: - Enabled - Disabled x-ms-enum: name: PublicNetworkAccess values: - value: Enabled description: Public network access is enabled. - value: Disabled description: Public network access is disabled. modelAsString: true description: Whether or not public network access is allowed for resources under the Video Analyzer account. x-nullable: true networkAccessControl: $ref: '#/definitions/NetworkAccessControl' description: Network access control for Video Analyzer. x-nullable: true provisioningState: type: string enum: - Failed - InProgress - Succeeded x-ms-enum: name: ProvisioningState values: - value: Failed description: Provisioning state failed. - value: InProgress description: Provisioning state in progress. - value: Succeeded description: Provisioning state succeeded. modelAsString: true description: Provisioning state of the Video Analyzer account. readOnly: true x-nullable: false privateEndpointConnections: items: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection type: array description: Private Endpoint Connections created under Video Analyzer account. readOnly: true type: object description: The properties of the Video Analyzer account. DataSourceConfiguration: type: object properties: providers: type: array items: $ref: '#/definitions/EtwProviderConfiguration' description: ETW providers configuration perfCounters: type: array items: $ref: '#/definitions/PerformanceCounterConfiguration' description: Performance counter configuration eventLogs: type: array items: $ref: '#/definitions/EventLogConfiguration' description: Windows event logs configuration. QueryPacksResource: properties: id: type: string readOnly: true description: Azure resource Id name: type: string description: Azure resource name readOnly: true type: type: string readOnly: true description: Azure resource type location: type: string description: Resource location x-ms-mutability: - create - read tags: additionalProperties: type: string description: Resource tags required: - location x-ms-azure-resource: true description: An azure resource object ModelingResource: description: Modeling resource details. type: object allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource properties: properties: description: Modeling resource properties. type: object properties: features: description: Modeling features controls the set of supported scenarios\models being computed. This can only be set at Modeling creation. type: string x-ms-mutability: - read - create enum: - Basic - Standard - Premium x-ms-enum: name: ModelingFeatures modelAsString: true frequency: description: Modeling frequency controls the modeling compute frequency. type: string x-ms-mutability: - read - create enum: - Low - Medium - High x-ms-enum: name: ModelingFrequency modelAsString: true size: description: Modeling size controls the maximum supported input data size. type: string x-ms-mutability: - read - create enum: - Small - Medium - Large x-ms-enum: name: ModelingSize modelAsString: true inputData: description: The configuration to raw CDM data to be used as Modeling resource input. $ref: '#/definitions/ModelingInputData' provisioningState: description: The resource provisioning state. type: string readOnly: true systemData: description: Metadata pertaining to creation and last modification of the resource. $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData VpnConnectionPacketCaptureStopParameters: description: Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection. properties: sasUrl: type: string description: SAS url for packet capture on vpn connection. linkConnectionNames: type: array description: List of site link connection names. items: type: string GitHubOwnerListResponse: type: object properties: value: description: Gets or sets list of resources. type: array items: $ref: '#/definitions/GitHubOwner' x-ms-identifiers: [] nextLink: description: Gets or sets next link to scroll over the results. type: string VpnServerConfigurationPolicyGroupProperties: type: object properties: isDefault: type: boolean description: Shows if this is a Default VpnServerConfigurationPolicyGroup or not. priority: type: integer format: int32 description: Priority for VpnServerConfigurationPolicyGroup. policyMembers: type: array items: $ref: '#/definitions/VpnServerConfigurationPolicyGroupMember' description: Multiple PolicyMembers for VpnServerConfigurationPolicyGroup. x-ms-identifiers: [] p2SConnectionConfigurations: type: array readOnly: true items: $ref: ./network.json#/definitions/SubResource description: List of references to P2SConnectionConfigurations. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the VpnServerConfigurationPolicyGroup resource. description: Parameters for VpnServerConfigurationPolicyGroup. CloudHsmClusterListResult: properties: value: type: array items: $ref: '#/definitions/CloudHsmCluster' description: The list of Cloud HSM Clusters. nextLink: type: string description: The URL to get the next set of Cloud HSM Clusters. description: List of Cloud HSM Clusters type: object RegenerateKeyInput: description: The request body for a RegenerateKey API. example: keyType: Primary properties: keyType: description: The keyType indicating which key you want to regenerate, Primary or Secondary. type: string enum: - Primary - Secondary x-ms-enum: name: KeyType modelAsString: false required: - keyType PolicyEvent: type: object description: Policy event record. properties: '@odata.id': description: OData entity ID; always set to null since policy event records do not have an entity ID. type: string '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string timestamp: description: Timestamp for the policy event record. type: string format: date-time resourceId: description: Resource ID. type: string policyAssignmentId: description: Policy assignment ID. type: string policyDefinitionId: description: Policy definition ID. type: string effectiveParameters: description: Effective parameters for the policy assignment. type: string isCompliant: description: Flag which states whether the resource is compliant against the policy assignment it was evaluated against. type: boolean subscriptionId: description: Subscription ID. type: string resourceType: description: Resource type. type: string resourceLocation: description: Resource location. type: string resourceGroup: description: Resource group name. type: string resourceTags: description: List of resource tags. type: string policyAssignmentName: description: Policy assignment name. type: string policyAssignmentOwner: description: Policy assignment owner. type: string policyAssignmentParameters: description: Policy assignment parameters. type: string policyAssignmentScope: description: Policy assignment scope. type: string policyDefinitionName: description: Policy definition name. type: string policyDefinitionAction: description: Policy definition action, i.e. effect. type: string policyDefinitionCategory: description: Policy definition category. type: string policySetDefinitionId: description: Policy set definition ID, if the policy assignment is for a policy set. type: string policySetDefinitionName: description: Policy set definition name, if the policy assignment is for a policy set. type: string policySetDefinitionOwner: description: Policy set definition owner, if the policy assignment is for a policy set. type: string policySetDefinitionCategory: description: Policy set definition category, if the policy assignment is for a policy set. type: string policySetDefinitionParameters: description: Policy set definition parameters, if the policy assignment is for a policy set. type: string managementGroupIds: description: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under. type: string policyDefinitionReferenceId: description: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set. type: string tenantId: description: Tenant ID for the policy event record. type: string principalOid: description: Principal object ID for the user who initiated the resource operation that triggered the policy event. type: string additionalProperties: description: The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated Assessment: type: object x-ms-azure-resource: true description: An assessment created for a group in the Migration project. required: - properties properties: id: type: string description: Path reference to this assessment. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessment/{assessmentName} readOnly: true name: type: string description: Unique name of an assessment. readOnly: true eTag: type: string description: For optimistic concurrency control. type: type: string description: Type of the object = [Microsoft.Migrate/projects/groups/assessments]. readOnly: true properties: description: Properties of the assessment. x-ms-client-flatten: true $ref: '#/definitions/AssessmentProperties' RemotePrivateEndpointConnection: description: Remote private endpoint connection details. type: object properties: id: description: Remote private endpoint connection ID. type: string readOnly: true CorsRule: description: CORS details. type: object required: - allowedOrigins properties: allowedOrigins: description: The origin domains that are permitted to make a request against the service via CORS. type: array items: type: string minItems: 1 allowedMethods: description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. type: array items: type: string allowedHeaders: description: The request headers that the origin domain may specify on the CORS request. type: array items: type: string exposedHeaders: description: The response headers to expose to CORS clients. type: array items: type: string maxAgeInSeconds: description: The number of seconds that the client/browser should cache a preflight response. type: integer format: int32 minimum: 0 ClusterMetricsConfigurationPatchProperties: type: object title: ClusterMetricsConfigurationPatchProperties represents the properties of metrics configuration for the cluster for patching. properties: collectionInterval: description: The interval in minutes by which metrics will be collected. type: integer format: int64 maximum: 1440 minimum: 1 enabledMetrics: description: The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. type: array items: type: string Resource_9: description: The Azure Resource Manager resource. properties: id: description: The id of the resource. readOnly: true type: string name: description: The name of the resource. readOnly: true type: string type: description: The type of the resource readOnly: true type: string location: type: string description: The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). tags: type: object additionalProperties: type: string description: Tags to help categorize the resource in the Azure portal. x-ms-azure-resource: true OSProfile: properties: computerName: type: string description: Specifies the host OS name of the AzureBareMetal instance. osType: readOnly: true type: string description: This property allows you to specify the type of the OS. version: readOnly: true type: string description: Specifies version of operating system. sshPublicKey: type: string description: Specifies the SSH public key used to access the operating system. description: Specifies the operating system settings for the AzureBareMetal instance. PagedItemDetails: type: object description: Paged collection of ItemDetails items properties: value: type: array description: The ItemDetails items on this page items: $ref: '#/definitions/ItemDetails' nextLink: type: string format: uri description: The link to the next page of items required: - value CloudError_3: x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody_3' description: An error response from the Container Instance service. ErrorDefinition_4: description: Error definition. properties: code: description: Service specific error code which serves as the substatus for the HTTP error code. type: string readOnly: true message: description: Description of the error. type: string readOnly: true target: description: The target of the error. type: string readOnly: true details: description: Internal error details. type: array items: $ref: '#/definitions/ErrorDefinition_4' readOnly: true additionalInfo: description: Additional scenario specific error details. type: array items: $ref: '#/definitions/TypedErrorInfo' readOnly: true MachineResultList: type: object description: List of machines. properties: value: type: array description: List of machines. items: $ref: '#/definitions/Machine' HealthBot: type: object description: Azure Health Bot resource definition allOf: - $ref: '#/definitions/TrackedResource' properties: sku: $ref: '#/definitions/Sku' description: SKU of the Azure Health Bot. identity: $ref: '#/definitions/Identity' description: The identity of the Azure Health Bot. properties: $ref: '#/definitions/HealthBotProperties' description: The set of properties specific to Azure Health Bot resource. required: - sku VpnConnectionStatus: type: string description: The current state of the vpn connection. readOnly: true enum: - Unknown - Connecting - Connected - NotConnected x-ms-enum: name: VpnConnectionStatus modelAsString: true KeyVaultProperties_2: properties: keyIdentifier: type: string description: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). currentKeyIdentifier: type: string description: The current key used to encrypt Video Analyzer account, including the key version. readOnly: true type: object required: - keyIdentifier description: The details for accessing the encryption keys in Key Vault. ManagementServerProperties: description: The properties of management server type: object properties: serverName: description: Management server Name type: string readOnly: true vmResId: description: Azure VM Resource Id of the Management server. type: string readOnly: true fqdn: description: Management server Fully Qualified Domain Name. type: string readOnly: true serverRoles: description: Represent whether the Server is a Management Server and/or Web Console Server. type: string readOnly: true healthState: description: Management server health state. type: string readOnly: true VpnGateway: required: - location properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnGatewayProperties' description: Properties of the VPN gateway. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. allOf: - $ref: ./network.json#/definitions/Resource description: VpnGateway Resource. VpnProfileResponse: properties: profileUrl: type: string description: URL to the VPN profile. description: Vpn Profile Response for package generation. ClusterAvailableVersion: type: object title: ClusterAvailableVersion represents the cluster version that the cluster manager can be asked to create and manage. properties: supportExpiryDate: description: The last date the version of the platform is supported. type: string readOnly: true targetClusterVersion: description: The version of the cluster to be deployed. type: string readOnly: true Event: description: A container group or container instance event. type: object readOnly: true properties: count: type: integer format: int32 readOnly: true description: The count of the event. firstTimestamp: type: string readOnly: true format: date-time description: The date-time of the earliest logged event. lastTimestamp: type: string readOnly: true format: date-time description: The date-time of the latest logged event. name: type: string readOnly: true description: The event name. message: type: string readOnly: true description: The event message. type: type: string readOnly: true description: The event type. UpdatableClusterProfile: type: object properties: serviceConfigsProfiles: type: array description: The service configs profiles. items: $ref: '#/definitions/ClusterServiceConfigsProfile' x-ms-identifiers: [] sshProfile: $ref: '#/definitions/SshProfile' autoscaleProfile: $ref: '#/definitions/AutoscaleProfile' authorizationProfile: $ref: '#/definitions/AuthorizationProfile' logAnalyticsProfile: $ref: '#/definitions/ClusterLogAnalyticsProfile' prometheusProfile: $ref: '#/definitions/ClusterPrometheusProfile' scriptActionProfiles: $ref: '#/definitions/ScriptActionProfiles' description: Cluster resource patch properties. ClientType: description: The application client type type: string enum: - none - dotnet - java - python - go - php - ruby - django - nodejs - springBoot - kafka-springBoot - jms-springBoot - dapr x-ms-enum: name: clientType modelAsString: true VnetValidationTestFailure: description: A class that describes a test that failed during NSG and UDR validation. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: VnetValidationTestFailure resource specific properties type: object properties: testName: description: The name of the test that failed. type: string details: description: The details of what caused the failure, e.g. the blocking rule name, etc. type: string x-ms-client-flatten: true ManagedCassandraManagedServiceIdentity: description: Identity for the resource. type: object properties: principalId: readOnly: true type: string description: The object id of the identity resource. tenantId: readOnly: true type: string description: The tenant id of the resource. type: type: string description: The type of the resource. enum: - SystemAssigned - None x-ms-enum: name: ManagedCassandraResourceIdentityType modelAsString: true Resource: type: object description: The resource model definition for a ARM tracked top level resource x-ms-azure-resource: true properties: id: description: Fully qualified resource Id for the resource. type: string readOnly: true name: description: The name of the resource type: string readOnly: true type: description: The type of the resource. type: string readOnly: true systemData: $ref: '#/definitions/SystemData' readOnly: true description: Metadata pertaining to creation and last modification of the resource TrunkedNetworkPatchParameters: type: object title: TrunkedNetworkPatchParameters represents the body of the request to patch the Trunked network. properties: tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string ConnectedClusterList: description: The paginated list of connected Clusters type: object properties: value: description: The list of connected clusters type: array items: $ref: '#/definitions/ConnectedCluster' nextLink: description: The link to fetch the next page of connected cluster type: string PrivateEndpointConnectionProperties_5: properties: privateEndpoint: properties: id: type: string description: The resource id of the private endpoint resource from Microsoft.Network provider. description: The private endpoint resource from Microsoft.Network provider. privateLinkServiceConnectionState: type: object properties: status: type: string description: Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. enum: - Pending - Approved - Rejected - Disconnected x-ms-enum: name: PrivateLinkServiceConnectionStatus modelAsString: false values: - value: Pending name: Pending description: The private endpoint connection has been created and is pending approval. - value: Approved name: Approved description: The private endpoint connection is approved and is ready for use. - value: Rejected name: Rejected description: The private endpoint connection has been rejected and cannot be used. - value: Disconnected name: Disconnected description: The private endpoint connection has been removed from the service. description: type: string description: The description for the private link service connection state. actionsRequired: type: string description: A description of any extra actions that may be required. default: None description: Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. PrivateEndpointConnectionListResult: type: object properties: value: type: array description: Array of private endpoint connections. items: $ref: '#/definitions/PrivateEndpointConnection' nextLink: type: string description: The URL to get the next set of private endpoint connections. description: List of private endpoint connections associated with the specified resource. TagValue: properties: id: readOnly: true type: string description: The tag value ID. tagValue: type: string description: The tag value. count: $ref: '#/definitions/TagCount' description: The tag value count. x-ms-azure-resource: true description: Tag information. ManagedProxyResource: description: The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. This proxy resource is explicitly created or updated by including it in the parent resource. properties: id: readOnly: true type: string description: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} x-ms-mutability: - read name: type: string description: The name of the resource x-ms-mutability: - read - create - update type: readOnly: true type: string description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. x-ms-mutability: - read x-ms-azure-resource: true StreamingPolicyContentKey: properties: label: type: string description: Label can be used to specify Content Key when creating a Streaming Locator policyName: type: string description: Policy used by Content Key tracks: type: array items: $ref: '#/definitions/TrackSelection' description: Tracks which use this content key type: object description: Class to specify properties of content key DataPlaneAuthOptions: properties: apiKeyOnly: type: object properties: {} description: Indicates that only the API key needs to be used for authentication. aadOrApiKey: $ref: '#/definitions/DataPlaneAadOrApiKeyAuthOption' description: Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. description: Defines the options for how the data plane API of a Search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. AccountResource_2: description: Account resource details. type: object allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource properties: properties: description: Account resource properties. type: object properties: configuration: description: Account configuration. This can only be set at RecommendationsService Account creation. type: string x-ms-mutability: - read - create enum: - Free - Capacity x-ms-enum: name: AccountConfiguration modelAsString: true endpointAuthentications: description: The list of service endpoints authentication details. $ref: '#/definitions/EndpointAuthenticationsList' cors: description: The list of CORS details. $ref: '#/definitions/CorsRuleList' reportsConnectionString: description: Connection string to write Accounts reports to. type: string provisioningState: description: The resource provisioning state. type: string readOnly: true systemData: description: Metadata pertaining to creation and last modification of the resource. $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData identity: description: The identity used for the resource. $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity AuthType: description: The authentication type. type: string enum: - systemAssignedIdentity - userAssignedIdentity - servicePrincipalSecret - servicePrincipalCertificate - secret - accessKey - userAccount - easyAuthMicrosoftEntraID x-ms-enum: name: AuthType modelAsString: true VirtualHubEffectiveRoute: description: The effective route configured on the virtual hub or specified resource. properties: addressPrefixes: description: The list of address prefixes. type: array items: type: string nextHops: description: The list of next hops. type: array items: type: string nextHopType: description: The type of the next hop. type: string asPath: description: The ASPath of this route. type: string routeOrigin: description: The origin of this route. type: string GetVpnSitesConfigurationRequest: properties: vpnSites: type: array items: type: string description: List of resource-ids of the vpn-sites for which config is to be downloaded. outputBlobSasUrl: type: string description: The sas-url to download the configurations for vpn-sites. required: - outputBlobSasUrl description: List of Vpn-Sites. ClusterPoolLogAnalyticsProfile: type: object description: Cluster pool log analytics profile used to enable or disable OMS agent for AKS cluster. required: - enabled properties: enabled: type: boolean description: True if log analytics is enabled for cluster pool, otherwise false. workspaceId: type: string description: Log analytics workspace to associate with the OMS agent. format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.OperationalInsights/workspaces ClusterMetricsConfigurationPatchParameters: type: object title: ClusterMetricsConfigurationPatchParameters represents the body of the request to patch the metrics configuration of cluster. properties: properties: $ref: '#/definitions/ClusterMetricsConfigurationPatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string CloudServicesNetworkPatchParameters: type: object title: CloudServicesNetworkPatchParameters represents the body of the request to patch the cloud services network. properties: properties: $ref: '#/definitions/CloudServicesNetworkPatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string AzureMonitorPrivateLinkScopeProperties: description: Properties that define a Azure Monitor PrivateLinkScope resource. properties: provisioningState: type: string description: 'Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.' readOnly: true privateEndpointConnections: readOnly: true description: List of private endpoint connections. type: array items: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection accessModeSettings: type: object $ref: '#/definitions/AccessModeSettings' description: Access mode settings required: - accessModeSettings ClusterMetricsConfiguration: type: object title: ClusterMetricsConfiguration represents the metrics configuration of an on-premises Network Cloud cluster. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/ClusterMetricsConfigurationProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true ValidateResponseError: description: Error details for when validation fails. type: object properties: code: description: Validation error code. type: string message: description: Validation error message. type: string GitHubConnector: description: Represents an ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource properties: properties: $ref: '#/definitions/GitHubConnectorProperties' PolicyEventsQueryResults: description: Query results. properties: '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string '@odata.count': description: OData entity count; represents the number of policy event records returned. type: integer format: int32 minimum: 0 '@odata.nextLink': description: Odata next link; URL to get the next set of results. type: string value: description: Query results. type: array items: $ref: '#/definitions/PolicyEvent' Resource_4: type: object description: An Azure resource. properties: id: description: Azure resource ID. type: string readOnly: true name: description: Azure resource name. type: string readOnly: true type: description: Azure resource type. type: string readOnly: true location: description: Location of the resource. type: string tags: description: resource tags. type: object additionalProperties: type: string x-ms-azure-resource: true BareMetalMachineCommandSpecification: type: object title: BareMetalMachineCommandSpecification represents the command and optional arguments to exercise against the bare metal machine. required: - command properties: arguments: description: The list of string arguments that will be passed to the script in order as separate arguments. type: array items: type: string command: description: The command to execute against the bare metal machine. type: string RouteMapMatchCondition: type: string description: Match condition to apply RouteMap rules. enum: - Unknown - Contains - Equals - NotContains - NotEquals x-ms-enum: name: RouteMapMatchCondition modelAsString: true SkuInformation: description: Information of the sku. type: object properties: sku: $ref: '#/definitions/Sku_2' description: The Sku. readOnly: true enabled: description: The sku is enabled or not. type: boolean readOnly: true properties: $ref: '#/definitions/SkuProperties' description: Properties of the sku. readOnly: true x-ms-client-flatten: true PolicyDefinitionSummary: description: Policy definition summary. properties: policyDefinitionId: description: Policy definition ID. type: string policyDefinitionReferenceId: description: Policy definition reference ID. type: string effect: description: Policy effect, i.e. policy definition action. type: string results: description: Non-compliance summary for the policy definition. $ref: '#/definitions/SummaryResults' ErrorDetail: title: Error details. type: object properties: code: description: The error's code. type: string message: description: A human readable error message. type: string target: description: Indicates which property in the request is responsible for the error. type: string value: description: Indicates which value in 'target' is responsible for the error. type: string resources: description: Indicates resources which were responsible for the error. type: array items: type: string additionalProperties: description: Additional properties that can be provided on the error details object type: object required: - code - message L2NetworkList: type: object title: L2NetworkList represents a list of L2 networks. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of L2 networks. type: array items: $ref: '#/definitions/L2Network' PolicyEvaluationDetails: type: object description: Policy evaluation details. properties: evaluatedExpressions: description: Details of the evaluated expressions. type: array items: $ref: '#/definitions/ExpressionEvaluationDetails' ifNotExistsDetails: description: Evaluation details of IfNotExists effect. type: object $ref: '#/definitions/IfNotExistsEvaluationDetails' ListVpnGatewaysResult: description: Result of the request to list VpnGateways. It contains a list of VpnGateways and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnGateway' description: List of VpnGateways. nextLink: type: string description: URL to get the next set of operation list results if there are any. PrivateLinkScopeValidationDetails: type: object properties: id: type: string readOnly: true description: Azure resource Id publicNetworkAccess: description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. $ref: '#/definitions/PublicNetworkAccessType_2' connectionDetails: type: array description: List of Private Endpoint Connection details. items: $ref: '#/definitions/ConnectionDetail' ResourceSku: description: Represents the SKU name and Azure pricing tier for Analysis Services resource. type: object properties: name: type: string description: Name of the SKU level. tier: type: string enum: - Development - Basic - Standard x-ms-enum: name: SkuTier modelAsString: true description: The name of the Azure pricing tier to which the SKU applies. capacity: type: integer format: int32 minimum: 1 maximum: 8 default: 1 description: The number of instances in the read only query pool. required: - name eventsUserInfo: description: User info for an event result type: object properties: id: description: ID of the user type: string accountId: description: Account ID of the user type: string authenticatedId: description: Authenticated ID of the user type: string DeploymentExtensionSpec: description: Extension sidecars to be added to the deployment. type: object properties: name: type: string description: Name of the extension. properties: type: object x-ms-client-flatten: true description: Extension specific properties properties: extensionType: type: string description: Type of extension to be added. version: type: string description: Version of the extension being used. settings: type: object description: Settings for the extension. protectedSettings: type: object description: Protected settings for the extension. required: - extensionType - version required: - name DeviceProperties: properties: deviceVendor: type: string description: Name of the device Vendor. deviceModel: type: string description: Model of the device. linkSpeedInMbps: type: integer format: int32 description: Link speed. description: List of properties of the device. AgreementProperties: properties: publisher: type: string description: Publisher identifier string of image being deployed. product: type: string description: Offer identifier string of image being deployed. plan: type: string description: Plan identifier string of image being deployed. licenseTextLink: type: string description: Link to HTML with Microsoft and Publisher terms. privacyPolicyLink: type: string description: Link to the privacy policy of the publisher. marketplaceTermsLink: type: string description: Link to HTML with Azure Marketplace terms. retrieveDatetime: type: string format: date-time description: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. signature: type: string description: Terms signature. accepted: type: boolean description: If any version of the terms have been accepted, otherwise false. description: Agreement Terms definition AccessPolicyProperties: properties: role: type: string enum: - Reader x-ms-enum: name: AccessPolicyRole values: - value: Reader description: Reader role allows for read-only operations to be performed through the client APIs. modelAsString: true description: Defines the access level granted by this policy. x-nullable: true authentication: $ref: '#/definitions/AuthenticationBase' description: Authentication method to be used when validating client API access. type: object description: Application level properties for the access policy resource. column: title: A table column. description: A column in a table. type: object properties: name: description: The name of this column. type: string type: description: The data type of this column. type: string MachineProperties: type: object description: Properties of a machine. properties: bootType: type: string description: Boot type of the machine. enum: - Unknown - EFI - BIOS readOnly: true x-ms-enum: name: MachineBootType modelAsString: true datacenterContainer: type: string description: Container defined in the management solution that this machine is part of in the datacenter. readOnly: true datacenterManagementServer: type: string description: Name of the server hosting the datacenter management solution. readOnly: true datacenterMachineId: type: string description: ID of the machine as tracked by the datacenter management solution. readOnly: true datacenterManagementServerId: type: string description: ID of the server hosting the datacenter management solution. readOnly: true description: type: string description: Description of the machine readOnly: true displayName: type: string description: User readable name of the machine as defined by the user in their private datacenter. readOnly: true megabytesOfMemory: type: number description: Memory in Megabytes. readOnly: true numberOfCores: type: integer description: Processor count. readOnly: true operatingSystem: type: string description: Operating System of the machine. readOnly: true groups: type: array description: List of references to the groups that the machine is member of. readOnly: true items: type: string readOnly: true description: Reference to a group that this machine is member of. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName} createdTimestamp: type: string format: date-time description: Time when this machine was created. Date-Time represented in ISO-8601 format. readOnly: true updatedTimestamp: type: string format: date-time description: Time when this machine was last updated. Date-Time represented in ISO-8601 format. readOnly: true discoveredTimestamp: type: string format: date-time description: Time when this machine was discovered by Azure Migrate agent. Date-Time represented in ISO-8601 format. readOnly: true disks: type: object description: Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object readOnly: true additionalProperties: $ref: '#/definitions/Disk' networkAdapters: type: object description: Dictionary of network adapters attached to the machine. Key is ID of network adapter. Value is a network adapter object readOnly: true additionalProperties: $ref: '#/definitions/NetworkAdapter' AccountResourceList_2: description: The list of RecommendationsService Account resources. type: object properties: nextLink: description: The link used to get the next page of RecommendationsService Account resources list. type: string value: description: The list of RecommendationsService Account resources. type: array items: $ref: '#/definitions/AccountResource_2' DetectorResponseProperties: type: object properties: value: type: string description: A base64 encoded string that represents the content of a detector. description: Detector response properties. AlertRuleLeafCondition: description: 'An Activity Log Alert rule condition that is met by comparing the field and value of an Activity Log event. This condition must contain ''field'' and either ''equals'' or ''containsAny''.' type: object properties: field: description: 'The name of the Activity Log event''s field that this condition will examine. The possible values for this field are (case-insensitive): ''resourceId'', ''category'', ''caller'', ''level'', ''operationName'', ''resourceGroup'', ''resourceProvider'', ''status'', ''subStatus'', ''resourceType'', or anything beginning with ''properties''.' type: string equals: description: The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met. type: string containsAny: description: The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met. type: array items: type: string DataPlaneAadOrApiKeyAuthOption: properties: aadAuthFailureMode: type: string description: Describes what response the data plane API of a Search service would send for requests that failed authentication. enum: - http403 - http401WithBearerChallenge x-ms-enum: name: AadAuthFailureMode modelAsString: false values: - value: http403 name: Http403 description: Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). - value: http401WithBearerChallenge name: Http401WithBearerChallenge description: Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. description: Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. AzureDevOpsRepo: description: Azure DevOps Repo Proxy Resource. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/AzureDevOpsRepoProperties' AttachedNetworkConfiguration: type: object title: AttachedNetworkConfiguration represents the set of workload networks to attach to a resource. properties: l2Networks: description: The list of Layer 2 Networks and related configuration for attachment. type: array items: $ref: '#/definitions/L2NetworkAttachmentConfiguration' x-ms-mutability: - read - create l3Networks: description: The list of Layer 3 Networks and related configuration for attachment. type: array items: $ref: '#/definitions/L3NetworkAttachmentConfiguration' x-ms-mutability: - read - create trunkedNetworks: description: The list of Trunked Networks and related configuration for attachment. type: array items: $ref: '#/definitions/TrunkedNetworkAttachmentConfiguration' x-ms-mutability: - read - create AssessmentProperties: type: object description: Properties of an assessment. required: - stage - azureOfferCode - timeRange - percentile - azureLocation - azureStorageRedundancy - scalingFactor - azurePricingTier - currency - azureHybridUseBenefit - discountPercentage properties: azureLocation: type: string enum: - Unknown - EastAsia - SoutheastAsia - AustraliaEast - AustraliaSoutheast - BrazilSouth - CanadaCentral - CanadaEast - WestEurope - NorthEurope - CentralIndia - SouthIndia - WestIndia - JapanEast - JapanWest - KoreaCentral - KoreaSouth - UkWest - UkSouth - NorthCentralUs - EastUs - WestUs2 - SouthCentralUs - CentralUs - EastUs2 - WestUs - WestCentralUs description: Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API. x-ms-enum: name: AzureLocation modelAsString: true azureOfferCode: type: string enum: - Unknown - MSAZR0003P - MSAZR0044P - MSAZR0059P - MSAZR0060P - MSAZR0062P - MSAZR0063P - MSAZR0064P - MSAZR0029P - MSAZR0022P - MSAZR0023P - MSAZR0148P - MSAZR0025P - MSAZR0036P - MSAZR0120P - MSAZR0121P - MSAZR0122P - MSAZR0123P - MSAZR0124P - MSAZR0125P - MSAZR0126P - MSAZR0127P - MSAZR0128P - MSAZR0129P - MSAZR0130P - MSAZR0111P - MSAZR0144P - MSAZR0149P description: Offer code according to which cost estimation is done. x-ms-enum: name: AzureOfferCode modelAsString: true azurePricingTier: type: string enum: - Standard - Basic description: Pricing tier for Size evaluation. x-ms-enum: name: AzurePricingTier modelAsString: true azureStorageRedundancy: type: string enum: - Unknown - LocallyRedundant - ZoneRedundant - GeoRedundant - ReadAccessGeoRedundant description: Storage Redundancy type offered by Azure. x-ms-enum: name: AzureStorageRedundancy modelAsString: true scalingFactor: type: number format: double description: Scaling factor used over utilization data to add a performance buffer for new machines to be created in Azure. Min Value = 1.0, Max value = 1.9, Default = 1.3. percentile: type: string enum: - Percentile50 - Percentile90 - Percentile95 - Percentile99 description: Percentile of performance data used to recommend Azure size. x-ms-enum: name: Percentile modelAsString: true timeRange: type: string enum: - Day - Week - Month description: Time range of performance data used to recommend a size. x-ms-enum: name: TimeRange modelAsString: true stage: type: string enum: - InProgress - UnderReview - Approved description: User configurable setting that describes the status of the assessment. x-ms-enum: name: AssessmentStage modelAsString: true currency: type: string enum: - Unknown - USD - DKK - CAD - IDR - JPY - KRW - NZD - NOK - RUB - SAR - ZAR - SEK - TRY - GBP - MXN - MYR - INR - HKD - BRL - TWD - EUR - CHF - ARS - AUD description: Currency to report prices in. x-ms-enum: name: Currency modelAsString: true azureHybridUseBenefit: type: string enum: - Unknown - 'Yes' - 'No' description: AHUB discount on windows virtual machines. x-ms-enum: name: AzureHybridUseBenefit modelAsString: true discountPercentage: type: number format: double description: Custom discount percentage to be applied on final costs. Can be in the range [0, 100]. pricesTimestamp: type: string format: date-time description: Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format. readOnly: true createdTimestamp: type: string format: date-time description: Time when this project was created. Date-Time represented in ISO-8601 format. readOnly: true updatedTimestamp: type: string format: date-time description: Time when this project was last updated. Date-Time represented in ISO-8601 format. readOnly: true monthlyComputeCost: type: number format: double description: Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month. readOnly: true monthlyBandwidthCost: type: number format: double description: Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month. readOnly: true monthlyStorageCost: type: number format: double description: Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month. readOnly: true status: type: string enum: - Created - Updated - Running - Completed - Invalid description: Whether the assessment has been created and is valid. readOnly: true x-ms-enum: name: AssessmentStatus modelAsString: true numberOfMachines: type: integer format: int32 description: Number of assessed machines part of this assessment. readOnly: true HubRouteTable: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/HubRouteTableProperties' description: Properties of the RouteTable resource. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. type: readOnly: true type: string description: Resource type. allOf: - $ref: ./network.json#/definitions/SubResource description: RouteTable resource in a virtual hub. ManagedInstance: type: object description: A SCOM instance resource allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource properties: properties: description: The properties of a SCOM instance resource $ref: '#/definitions/MonitoringInstanceProperties' identity: description: The Azure Active Directory identity of the SCOM instance $ref: '#/definitions/ManagedIdentity' x-ms-mutability: - create - read VpnNatRuleMapping: properties: addressSpace: type: string description: Address space for Vpn NatRule mapping. portRange: type: string description: Port range for Vpn NatRule mapping. description: Vpn NatRule mapping. ServiceUpdate: type: object properties: properties: $ref: '#/definitions/ServiceProperties' x-ms-client-flatten: true description: The service properties to be updated. PricingDimension: type: object description: Information about pricing dimension. properties: id: type: string description: Unique id of this pricing dimension. name: type: string description: The display name of this pricing dimension. CheckNameAvailabilityParameters_2: properties: name: type: string description: The name to check for availability type: type: string enum: - Microsoft.Batch/batchAccounts x-ms-enum: name: ResourceType modelAsString: false values: - value: Microsoft.Batch/batchAccounts description: The Batch account resource type. name: BatchAccounts description: The resource type. required: - name - type description: Parameters for a check name availability request. AssessmentResultList: type: object description: List of assessments. properties: value: type: array description: List of assessments. items: $ref: '#/definitions/Assessment' CustomHostnameSitesCollection: description: Collection of custom hostname sites required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/CustomHostnameSites' nextLink: description: Link to next page of resources. type: string readOnly: true VideoAnalyzerIdentity: properties: type: type: string description: The identity type. userAssignedIdentities: $ref: '#/definitions/UserAssignedManagedIdentities' description: The User Assigned Managed Identities. type: object required: - type description: The managed identity for the Video Analyzer resource. PackageVersionInfo: description: Current version of each updatable component. type: object properties: packageType: description: Package type type: string version: description: Package version type: string lastUpdated: description: Last time this component was updated. type: string format: date-time ClusterInstanceViewResult: type: object description: Cluster Instance View. required: - name - properties properties: name: type: string description: Name of the instance view. properties: description: Properties of the instance view. x-ms-client-flatten: true allOf: - $ref: '#/definitions/ClusterInstanceViewProperties' VpnSite: required: - location properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnSiteProperties' description: Properties of the VPN site. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. allOf: - $ref: ./network.json#/definitions/Resource description: VpnSite Resource. TagsResource_4: type: object properties: tags: type: object additionalProperties: type: string description: Resource tags description: A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance. Resource_3: type: object description: The Resource model definition. properties: id: readOnly: true type: string description: The resource id. name: readOnly: true type: string description: The resource name. type: readOnly: true type: string description: The resource type. location: type: string description: The resource location. tags: type: object additionalProperties: type: string description: The resource tags. zones: description: The zones for the container group. type: array items: type: string x-ms-azure-resource: true GitHubConnectorStatsProperties: type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState_3' ownersCount: format: int64 description: Gets or sets owners count. type: integer reposCount: format: int64 description: Gets or sets repos count. type: integer EnvironmentVariable: description: The environment variable to set within the container instance. type: object properties: name: type: string description: The name of the environment variable. value: type: string description: The value of the environment variable. secureValue: type: string description: The value of the secure environment variable. x-ms-secret: true required: - name ClusterVersionProperties: type: object description: Cluster version properties. properties: clusterType: type: string description: The type of cluster. pattern: ^[a-zA-Z][a-zA-Z0-9]{0,31}$ clusterVersion: $ref: '#/definitions/ThreePartVersionPattern' ossVersion: $ref: '#/definitions/ThreePartVersionPattern' clusterPoolVersion: type: string description: The two part cluster pool version. If the cluster version is before cluster pool version on-board, the return value will be empty string example: '1.0' isPreview: type: boolean description: Indicate if this version is in preview or not. default: false components: $ref: '#/definitions/ClusterComponents' ListHubVirtualNetworkConnectionsResult: description: List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/HubVirtualNetworkConnection' description: List of HubVirtualNetworkConnections. nextLink: type: string description: URL to get the next set of operation list results if there are any. AzureDevOpsRepoProperties: description: AzureDevOps Repo properties. type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState_3' orgName: description: Gets or sets AzureDevOps org Name. type: string readOnly: true projectName: description: Gets or sets AzureDevOps project Name. type: string readOnly: true repoId: description: Gets or sets Azure DevOps repo id. type: string readOnly: true repoUrl: description: Gets or sets AzureDevOps repo url. type: string readOnly: true visibility: description: Gets or sets AzureDevOps repo visibility, whether it is public or private etc. type: string readOnly: true actionableRemediation: $ref: '#/definitions/ActionableRemediation' SessionJobFailurePolicy: type: string description: Policy controlling the behavior of the Session when a job in the session fails. enum: - Abort - Continue x-ms-enum: name: SessionJobFailurePolicy modelAsString: true values: - name: Abort value: Abort description: New jobs submitted after a job fails will be rejected. - name: Continue value: Continue description: New jobs submitted after a job fails will be accepted. SecurityContextDefinition: description: The security context for the container. type: object properties: privileged: type: boolean description: The flag to determine if the container permissions is elevated to Privileged. allowPrivilegeEscalation: type: boolean description: A boolean value indicating whether the init process can elevate its privileges capabilities: description: The capabilities to add or drop from a container. $ref: '#/definitions/SecurityContextCapabilitiesDefinition' runAsGroup: type: integer format: int32 description: Sets the User GID for the container. runAsUser: type: integer format: int32 description: Sets the User UID for the container. seccompProfile: type: string description: a base64 encoded string containing the contents of the JSON in the seccomp profile Service: type: object properties: properties: $ref: '#/definitions/ServiceProperties' description: The properties of the service. x-ms-client-flatten: true x-ms-mutability: - read - create identity: $ref: ../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity description: The identity of the service. description: The service entity. allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource ErrorResponse: description: Error response. properties: error: $ref: '#/definitions/ErrorDefinition' description: The error details. HealthState_2: type: string description: The health state of a resource such as Application, Service, or Network. enum: - Invalid - Ok - Warning - Error - Unknown x-ms-enum: name: HealthState modelAsString: true values: - value: Invalid description: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero. - value: Ok description: Indicates the health state is okay. The value is 1. - value: Warning description: Indicates the health state is at a warning level. The value is 2. - value: Error description: Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3. - value: Unknown description: Indicates an unknown health status. The value is 65535. CloudServicesNetwork: description: 'Upon creation, the additional services that are provided by the platform will be allocated and represented in the status of this resource. All resources associated with this cloud services network will be part of the same layer 2 (L2) isolation domain. At least one service network must be created but may be reused across many virtual machines and/or Hybrid AKS clusters.' type: object title: CloudServicesNetwork represents additional egress information that will be used by associated virtual machines or hybrid AKS clusters. required: - extendedLocation properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/CloudServicesNetworkProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true ErrorDetail_2: description: The error detail. properties: code: readOnly: true type: string description: The error code. message: readOnly: true type: string description: The error message. target: readOnly: true type: string description: The error target. details: readOnly: true type: array items: $ref: '#/definitions/ErrorDetail_2' description: The error details. additionalInfo: readOnly: true type: array items: $ref: '#/definitions/ErrorAdditionalInfo_2' description: The error additional info. AdministrativeCredentials: type: object title: AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication. required: - username - password properties: password: description: The password of the administrator of the device used during initialization. type: string minLength: 1 x-ms-secret: true username: description: The username of the administrator of the device used during initialization. type: string minLength: 1 SubscriptionState_2: description: Subscription notification state. type: string enum: - NotDefined - Enabled - Warned - PastDue - Disabled - Deleted - Deleting - PartiallyDeleted x-ms-enum: name: SubscriptionState modelAsString: true values: - description: Subscription is active. New resources can be created. name: Enabled value: Enabled - description: This state is not used in Azure Stack. name: PastDue value: PastDue - description: This state is not used in Azure Stack. name: Warned value: Warned - description: Subscription is not active and usage is not reported. Resources are shut down (VMs stopped and deallocated, IP addresses are freed, etc). During this period, the Azure Stack Operator can re-enable the subscription which allows creation of new resources but doesn’t automatically restore disabled resources. name: Disabled value: Disabled - description: This state is unique to Azure Stack and is only visible to the Azure Stack Operator, and if used, to the respective Delegated Provider. Resources and Data are being deleted before subscription state is set to Deleted. This state cannot be reversed. It means that deletion is in progress. name: Deleting value: Deleting - description: Final state of subscription. All resources and data are deleted. This state cannot be reversed. name: Deleted value: Deleted - description: This state is not used in Azure Stack. name: NotDefined value: NotDefined - description: This state is unique to Azure Stack and is only visible to the Azure Stack Operator, and if used, to the respective Delegated Provider. It means that deletion failed. You can’t reverse the deletion process, so in this state all you can do is restart deletion. This state is not reported to RPs. name: PartiallyDeleted value: PartiallyDeleted AgentPoolUpgradeSettings: type: object title: AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool. properties: maxSurge: description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. type: string default: '1' DeviceCapabilityResponse: description: Device capabilities for given sku in a region type: object properties: deviceCapabilityDetails: description: List of device capabilities available for a given region and a given sku type: array items: $ref: '#/definitions/DeviceCapabilityDetails' readOnly: true x-ms-identifiers: [] AccountList: description: List of Accounts. type: object properties: nextLink: description: The link used to get the next page of Accounts list. type: string value: description: List of Accounts. type: array items: $ref: '#/definitions/Account' AttestationListResult: description: List of attestations. properties: value: description: Array of attestation definitions. type: array items: $ref: '#/definitions/Attestation' readOnly: true nextLink: type: string description: The URL to get the next set of results. readOnly: true Parameter: properties: routePrefix: type: array description: List of route prefixes. items: type: string community: type: array description: List of BGP communities. items: type: string asPath: type: array description: List of AS paths. items: type: string description: Parameters for an Action. type: object PrivateEndpointConnection_4: properties: properties: $ref: '#/definitions/PrivateEndpointConnectionProperties_5' description: Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/Resource description: Describes an existing Private Endpoint connection to the Azure Cognitive Search service. ScheduleBasedConfig: type: object description: Profile of schedule based Autoscale. required: - timeZone - defaultCount - schedules properties: timeZone: type: string description: User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. defaultCount: type: integer format: int32 description: Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down) schedules: type: array description: This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). items: $ref: '#/definitions/Schedule' x-ms-identifiers: [] PagedJobDetails: type: object description: Paged collection of JobDetails items properties: value: type: array description: The JobDetails items on this page items: $ref: '#/definitions/JobDetails' nextLink: type: string format: uri description: The link to the next page of items required: - value ProvisioningState_5: description: Provisioning status of the managed resource. readOnly: true enum: - Succeeded - Failed - Canceled type: string x-ms-enum: name: ProvisioningState modelAsString: true StorageApplianceList: type: object title: StorageApplianceList represents a list of storage appliances. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of storage appliances. type: array items: $ref: '#/definitions/StorageAppliance' GlobalCsmSkuDescription: description: A Global SKU Description. type: object properties: name: description: Name of the resource SKU. type: string tier: description: Service Tier of the resource SKU. type: string size: description: Size specifier of the resource SKU. type: string family: description: Family code of the resource SKU. type: string capacity: $ref: ./CommonDefinitions.json#/definitions/SkuCapacity description: Min, max, and default scale values of the SKU. locations: description: Locations of the SKU. type: array items: type: string capabilities: description: Capabilities of the SKU, e.g., is traffic manager enabled? type: array items: $ref: ./CommonDefinitions.json#/definitions/Capability x-ms-identifiers: - name QuotaDimension: type: object description: Information about a specific quota dimension. properties: id: type: string description: Unique id of this dimension. scope: type: string description: The scope of this quota dimension. period: type: string description: The reset period of this quota dimension. quota: type: number description: The max limit of this dimension. name: type: string description: The display name of this quota dimension. description: type: string description: A description about this quota dimension. unit: type: string description: The standard unit of measurement used for this quota dimension. unitPlural: type: string description: The standard unit of measurement used for this quota dimension in plural form. VirtualRouterAutoScaleConfiguration: type: object properties: minCapacity: type: integer format: int32 minimum: 0 description: The minimum number of scale units for VirtualHub Router. description: The VirtualHub Router autoscale configuration. ClusterPoolVersionProperties: type: object description: Cluster pool version properties. properties: clusterPoolVersion: $ref: '#/definitions/ClusterPoolVersionPattern' aksVersion: type: string description: AKS version. example: '1.24' isPreview: type: boolean description: Indicate if this version is in preview or not. default: false SkuCapacity: description: Capacity of the sku. type: object properties: usable: description: Usable capacity in TB. type: string readOnly: true maximum: description: Maximum capacity in TB. type: string readOnly: true individualSkuUsable: type: string description: Maximum capacity per device in TB. readOnly: true PropagatedRouteTable: description: The list of RouteTables to advertise the routes to. properties: labels: type: array description: The list of labels. items: type: string ids: type: array description: The list of resource ids of all the RouteTables. items: $ref: ./network.json#/definitions/SubResource PrivateEndpointConnectionProxyProvisioningState: type: string readOnly: true description: The current provisioning state. enum: - Succeeded - Creating - Deleting - Failed x-ms-enum: name: PrivateEndpointConnectionProxyProvisioningState modelAsString: true BlobDetails: type: object description: The details (name and container) of the blob to store or download data. properties: containerName: type: string description: The container name. x-ms-mutability: - read - create blobName: type: string description: The blob name. x-ms-mutability: - read - create required: - containerName ExpressionEvaluationDetails: type: object description: Evaluation details of policy language expressions. properties: result: description: Evaluation result. type: string expression: description: Expression evaluated. type: string path: description: Property path if the expression is a field or an alias. type: string expressionValue: description: Value of the expression. type: object targetValue: description: Target value to be compared with the expression value. type: object operator: description: Operator to compare the expression value and the target value. type: string ProviderDescription: type: object description: Information about an offering. A provider offering is an entity that offers Targets to run Azure Quantum Jobs. properties: id: type: string description: Unique provider's id. name: type: string description: Provider's display name. readOnly: true properties: type: object description: A list of provider-specific properties. $ref: '#/definitions/ProviderProperties' ResourceLimits_2: description: This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted. type: object properties: memoryInGB: description: The memory limit in GB. type: number format: double cpu: description: CPU limits in cores. At present, only full cores are supported. type: number format: double ValidationInputResponse: description: Minimum properties that should be present in each individual validation response. required: - validationType type: object properties: validationType: description: Identifies the type of validation response. enum: - ValidateAddress - ValidateSubscriptionIsAllowedToCreateJob - ValidatePreferences - ValidateCreateOrderLimit - ValidateSkuAvailability - ValidateDataTransferDetails type: string x-ms-enum: name: ValidationInputDiscriminator modelAsExtensible: true values: - value: ValidateAddress description: Identify request and response of address validation. - value: ValidateSubscriptionIsAllowedToCreateJob description: Identify request and response for validation of subscription permission to create job. - value: ValidatePreferences description: Identify request and response of preference validation. - value: ValidateCreateOrderLimit description: Identify request and response of create order limit for subscription validation. - value: ValidateSkuAvailability description: Identify request and response of active job limit for sku availability. - value: ValidateDataTransferDetails description: Identify request and response of data transfer details validation. error: $ref: '#/definitions/CloudError_4' description: Error code and message of validation response. readOnly: true discriminator: validationType CommandPublicResource: description: resource representing a command type: object properties: command: type: string description: The command which should be run commandId: type: string description: The unique id of command arguments: type: object description: The arguments for the command to be run host: type: string description: IP address of the cassandra host to run the command on isAdmin: type: boolean description: Whether command has admin privileges cassandraStopStart: type: boolean description: If true, stops cassandra before executing the command and then start it again readWrite: type: boolean description: If true, allows the command to *write* to the cassandra directory, otherwise read-only. result: type: string description: Result output of the command. status: type: string description: Status of the command. enum: - Done - Running - Enqueue - Processing - Finished - Failed x-ms-enum: name: CommandStatus modelAsString: true outputFile: type: string description: The name of the file where the result is written. 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. CheckNameAvailabilityInput: description: The request body for CheckNameAvailability API. example: name: contosomedia type: mediaservices required: - name - type properties: name: description: The name of the resource. A name must be globally unique. type: string pattern: ^[a-z0-9]{3,24}$ minLength: 3 maxLength: 24 type: description: The type of the resource - mediaservices. $ref: '#/definitions/ResourceType' ContainerPort: description: The port exposed on the container instance. type: object properties: protocol: type: string description: The protocol associated with the port. enum: - TCP - UDP x-ms-enum: name: ContainerNetworkProtocol modelAsString: true port: type: integer format: int32 description: The port number exposed within the container group. required: - port SmsReceiver: description: An SMS receiver. type: object properties: name: type: string description: The name of the SMS receiver. Names must be unique across all receivers within an action group. countryCode: type: string description: The country code of the SMS receiver. phoneNumber: type: string description: The phone number of the SMS receiver. status: readOnly: true $ref: '#/definitions/ReceiverStatus' description: The status of the receiver. required: - name - countryCode - phoneNumber ClusterPatchProperties: type: object description: Cluster resource patch data. properties: clusterProfile: $ref: '#/definitions/UpdatableClusterProfile' CheckNameAvailabilityDefinition: description: The check name availability action definition. type: object properties: name: description: The resource name to verify. type: string resourceType: description: The resource type to verify. type: string ConnectedCluster: type: object required: - properties - identity properties: identity: $ref: '#/definitions/ConnectedClusterIdentity' description: The identity of the connected cluster. kind: $ref: '#/definitions/ConnectedClusterKind' description: The kind of connected cluster. properties: x-ms-client-flatten: true $ref: '#/definitions/ConnectedClusterProperties' description: Describes the connected cluster resource properties. systemData: $ref: '#/definitions/SystemData_2' readOnly: true description: Metadata pertaining to creation and last modification of the resource allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource description: Represents a connected cluster. TrinoCoordinator: type: object description: Trino Coordinator. properties: debug: $ref: '#/definitions/TrinoDebugConfig' x-ms-client-flatten: true highAvailabilityEnabled: type: boolean description: 'The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true.' default: true RemediationDeployment: description: Details of a single deployment created by the remediation. properties: remediatedResourceId: type: string description: Resource ID of the resource that is being remediated by the deployment. readOnly: true deploymentId: type: string description: Resource ID of the template deployment that will remediate the resource. readOnly: true status: type: string description: Status of the remediation deployment. readOnly: true resourceLocation: type: string description: Location of the resource that is being remediated. readOnly: true error: $ref: '#/definitions/ErrorDefinition_4' description: Error encountered while remediated the resource. readOnly: true createdOn: type: string format: date-time description: The time at which the remediation was created. readOnly: true lastUpdatedOn: type: string format: date-time description: The time at which the remediation deployment was last updated. readOnly: true AzureBareMetalInstance: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/AzureBareMetalInstanceProperties' description: AzureBareMetal instance properties allOf: - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource description: AzureBareMetal instance info on Azure (ARM properties and AzureBareMetal properties) ContainerInstanceView: description: Runtime information of a container instance. type: object properties: restartCount: type: integer description: The number of times the container has been restarted. currentState: $ref: '#/definitions/ContainerState_2' description: Current container instance state. previousState: $ref: '#/definitions/ContainerState_2' description: Previous container instance state. events: description: The events of this container instance. type: array items: $ref: '#/definitions/ContainerEvent' VpnServerConfigurationProperties: properties: name: type: string description: The name of the VpnServerConfiguration that is unique within a resource group. vpnProtocols: type: array items: type: string description: VPN protocol enabled for the VpnServerConfiguration. enum: - IkeV2 - OpenVPN x-ms-enum: name: VpnGatewayTunnelingProtocol modelAsString: true description: VPN protocols for the VpnServerConfiguration. vpnAuthenticationTypes: type: array items: type: string description: VPN authentication types enabled for the VpnServerConfiguration. enum: - Certificate - Radius - AAD x-ms-enum: name: VpnAuthenticationType modelAsString: true description: VPN authentication types for the VpnServerConfiguration. vpnClientRootCertificates: type: array items: $ref: '#/definitions/VpnServerConfigVpnClientRootCertificate' description: VPN client root certificate of VpnServerConfiguration. vpnClientRevokedCertificates: type: array items: $ref: '#/definitions/VpnServerConfigVpnClientRevokedCertificate' description: VPN client revoked certificate of VpnServerConfiguration. radiusServerRootCertificates: type: array items: $ref: '#/definitions/VpnServerConfigRadiusServerRootCertificate' description: Radius Server root certificate of VpnServerConfiguration. radiusClientRootCertificates: type: array items: $ref: '#/definitions/VpnServerConfigRadiusClientRootCertificate' description: Radius client root certificate of VpnServerConfiguration. vpnClientIpsecPolicies: type: array items: $ref: ./virtualNetworkGateway.json#/definitions/IpsecPolicy description: VpnClientIpsecPolicies for VpnServerConfiguration. radiusServerAddress: type: string description: The radius server address property of the VpnServerConfiguration resource for point to site client connection. radiusServerSecret: type: string description: The radius secret property of the VpnServerConfiguration resource for point to site client connection. radiusServers: type: array items: $ref: ./virtualNetworkGateway.json#/definitions/RadiusServer description: Multiple Radius Server configuration for VpnServerConfiguration. aadAuthenticationParameters: $ref: '#/definitions/AadAuthenticationParameters' description: The set of aad vpn authentication parameters. provisioningState: readOnly: true type: string description: 'The provisioning state of the VpnServerConfiguration resource. Possible values are: ''Updating'', ''Deleting'', and ''Failed''.' p2SVpnGateways: type: array readOnly: true items: $ref: '#/definitions/P2SVpnGateway' description: List of references to P2SVpnGateways. configurationPolicyGroups: type: array description: List of all VpnServerConfigurationPolicyGroups. items: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' etag: readOnly: true type: string description: A unique read-only string that changes whenever the resource is updated. description: Parameters for VpnServerConfiguration. HybridComputePrivateLinkScope: type: object properties: properties: description: Properties that define a Azure Arc PrivateLinkScope resource. $ref: '#/definitions/HybridComputePrivateLinkScopeProperties' systemData: readOnly: true description: The system meta data relating to this resource. $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData allOf: - $ref: '#/definitions/PrivateLinkScopesResource' description: An Azure Arc PrivateLinkScope definition. ComponentLinkedStorageAccountsPatch: description: An Application Insights component linked storage accounts patch type: object properties: properties: $ref: '#/definitions/LinkedStorageAccountsProperties' description: The properties of the linked storage accounts. x-ms-client-flatten: true eventsApplicationInfo: description: Application info for an event result type: object properties: version: description: Version of the application type: string NetworkRef: description: Describes a network reference in a service. type: object properties: name: type: string description: Name of the network. 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. ControlPlaneNodePatchConfiguration: type: object title: ControlPlaneNodePatchConfiguration represents the properties of the control plane that can be patched for this Kubernetes cluster. properties: administratorConfiguration: $ref: '#/definitions/AdministratorConfigurationPatch' description: The configuration of administrator credentials for the control plane nodes. count: description: The number of virtual machines that use this configuration. type: integer format: int64 minimum: 1 DetectorListResult: type: object properties: value: type: array items: $ref: '#/definitions/DetectorResponse' description: The collection of Batch account detectors returned by the listing operation. nextLink: type: string description: The URL to get the next set of results. description: Values returned by the List operation. Rack: type: object title: Rack represents the hardware of the rack and is dependent upon the cluster for lifecycle. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/RackProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true OAuth2PermissionGrantHealthReportList: description: List of OAuth2PermissionGrant health reports for the application. properties: value: type: array description: A report of the health status of an OAuth2PermissionGrant. items: $ref: '#/definitions/OAuth2PermissionGrantHealthReport' x-ms-identifiers: - oAuth2PermissionGrant/resource nextLink: description: URI to the next page. type: string ThroughputPoolResource: description: An Azure Cosmos DB Throughputpool. type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ThroughputPoolProperties' allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource InstanceList: description: List of Instances. type: object properties: nextLink: description: The link used to get the next page of Instances list. type: string value: description: List of Instances. type: array items: $ref: '#/definitions/Instance' ServicePrincipalInformation: type: object title: ServicePrincipalInformation represents the details of the service principal to be used by the cluster during Arc Appliance installation. required: - tenantId - principalId - applicationId - password properties: applicationId: description: The application ID, also known as client ID, of the service principal. type: string password: description: The password of the service principal. type: string x-ms-secret: true principalId: description: The principal ID, also known as the object ID, of the service principal. type: string tenantId: description: The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. type: string EnergyService: required: - location type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource properties: properties: $ref: '#/definitions/EnergyServiceProperties' tags: description: Resource tags. type: object additionalProperties: type: string location: description: Geo-location where the resource lives. type: string CommandOutput: description: Response of /command api type: object properties: commandOutput: type: string description: Output of the command. ImageRegistryCredential_2: description: Image registry credential. type: object properties: server: type: string description: Docker image registry server, without protocol such as `http` and `https`. username: type: string description: The username for the private registry. password: type: string description: The password for the private registry. required: - server - username InitialAgentPoolConfiguration: type: object title: InitialAgentPoolConfiguration specifies the configuration of a pool of virtual machines that are initially defined with a Kubernetes cluster. required: - count - mode - vmSkuName - name properties: administratorConfiguration: $ref: '#/definitions/AdministratorConfiguration' description: The administrator credentials to be used for the nodes in this agent pool. x-ms-mutability: - read - create agentOptions: $ref: '#/definitions/AgentOptions' description: The configurations that will be applied to each agent in this agent pool. x-ms-mutability: - read - create attachedNetworkConfiguration: $ref: '#/definitions/AttachedNetworkConfiguration' description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. x-ms-mutability: - read - create availabilityZones: description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. type: array items: type: string x-ms-mutability: - read - create count: description: The number of virtual machines that use this configuration. type: integer format: int64 x-ms-mutability: - read - create labels: description: The labels applied to the nodes in this agent pool. type: array items: $ref: '#/definitions/KubernetesLabel' x-ms-mutability: - read - create mode: description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. type: string enum: - System - User - NotApplicable x-ms-enum: modelAsString: true name: AgentPoolMode x-ms-mutability: - read - create name: description: The name that will be used for the agent pool resource representing this agent pool. type: string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ x-ms-mutability: - read - create taints: description: The taints applied to the nodes in this agent pool. type: array items: $ref: '#/definitions/KubernetesLabel' x-ms-mutability: - read - create upgradeSettings: $ref: '#/definitions/AgentPoolUpgradeSettings' description: The configuration of the agent pool. vmSkuName: description: The name of the VM SKU that determines the size of resources allocated for node VMs. type: string x-ms-mutability: - read - create KubernetesClusterProperties: type: object title: KubernetesClusterProperties represents the properties of Kubernetes cluster resource. required: - initialAgentPoolConfigurations - controlPlaneNodeConfiguration - kubernetesVersion - networkConfiguration properties: aadConfiguration: $ref: '#/definitions/AadConfiguration' description: The Azure Active Directory Integration properties. x-ms-mutability: - read - create administratorConfiguration: $ref: '#/definitions/AdministratorConfiguration' description: The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values. attachedNetworkIds: description: The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools. type: array items: type: string readOnly: true availableUpgrades: description: The list of versions that this Kubernetes cluster can be upgraded to. type: array items: $ref: '#/definitions/AvailableUpgrade' x-ms-identifiers: [] readOnly: true clusterId: description: The resource ID of the Network Cloud cluster. type: string format: arm-id readOnly: true connectedClusterId: description: The resource ID of the connected cluster set up when this Kubernetes cluster is created. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.Kubernetes/connectedClusters readOnly: true controlPlaneKubernetesVersion: description: The current running version of Kubernetes on the control plane. type: string readOnly: true controlPlaneNodeConfiguration: $ref: '#/definitions/ControlPlaneNodeConfiguration' description: The defining characteristics of the control plane for this Kubernetes Cluster. detailedStatus: description: The current status of the Kubernetes cluster. type: string enum: - Available - Error - Provisioning x-ms-enum: modelAsString: true name: KubernetesClusterDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true featureStatuses: description: The current feature settings. type: array items: $ref: '#/definitions/FeatureStatus' x-ms-identifiers: - name readOnly: true initialAgentPoolConfigurations: description: The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource. type: array minItems: 1 items: $ref: '#/definitions/InitialAgentPoolConfiguration' x-ms-identifiers: - name x-ms-mutability: - read - create kubernetesVersion: description: The Kubernetes version for this cluster. Accepts n.n, n.n.n, and n.n.n-n format. The interpreted version used will be resolved into this field after creation or update. type: string managedResourceGroupConfiguration: $ref: '#/definitions/ManagedResourceGroupConfiguration' description: The configuration of the managed resource group associated with the resource. networkConfiguration: $ref: '#/definitions/NetworkConfiguration' description: The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster. x-ms-mutability: - read - create nodes: description: The details of the nodes in this cluster. type: array items: $ref: '#/definitions/KubernetesClusterNode' x-ms-identifiers: - name readOnly: true provisioningState: description: The provisioning state of the Kubernetes cluster resource. type: string enum: - Succeeded - Failed - Canceled - Accepted - InProgress - Created - Updating - Deleting x-ms-enum: modelAsString: true name: KubernetesClusterProvisioningState readOnly: true ContainerCodePackageProperties: description: Describes a container and its runtime properties. type: object properties: name: description: The name of the code package. type: string image: description: The Container image to use. type: string imageRegistryCredential: $ref: '#/definitions/ImageRegistryCredential_2' description: Image registry credential. entrypoint: description: Override for the default entry point in the container. type: string commands: description: Command array to execute within the container in exec form. type: array items: type: string environmentVariables: description: The environment variables to set in this container type: array items: $ref: '#/definitions/EnvironmentVariable_2' settings: description: The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets". type: array items: $ref: '#/definitions/Setting' labels: description: The labels to set in this container. type: array items: $ref: '#/definitions/ContainerLabel' endpoints: description: The endpoints exposed by this container. type: array items: $ref: '#/definitions/EndpointProperties' resources: $ref: '#/definitions/ResourceRequirements_2' description: This type describes the resource requirements for a container or a service. volumeRefs: description: The volumes to be attached to the container. type: array items: $ref: '#/definitions/ContainerVolume' instanceView: readOnly: true $ref: '#/definitions/ContainerInstanceView' description: Runtime information of a container instance. diagnostics: $ref: '#/definitions/DiagnosticsRef' description: Reference to sinks in DiagnosticsDescription. required: - name - image - resources eventsResultData: description: Events query result data. type: object discriminator: type properties: id: description: The unique ID for this event. type: string type: description: The type of event. $ref: '#/definitions/eventType' count: description: Count of the event type: integer format: int64 timestamp: description: Timestamp of the event type: string format: date-time customDimensions: description: Custom dimensions of the event type: object properties: additionalProperties: type: object additionalProperties: type: object customMeasurements: description: Custom measurements of the event type: object properties: additionalProperties: type: object additionalProperties: type: object operation: description: Operation info of the event $ref: '#/definitions/eventsOperationInfo' session: description: Session info of the event $ref: '#/definitions/eventsSessionInfo' user: description: User info of the event $ref: '#/definitions/eventsUserInfo' cloud: description: Cloud info of the event $ref: '#/definitions/eventsCloudInfo' ai: description: AI info of the event $ref: '#/definitions/eventsAiInfo' application: description: Application info of the event $ref: '#/definitions/eventsApplicationInfo' client: description: Client info of the event $ref: '#/definitions/eventsClientInfo' required: - type ClusterVersion: type: object description: Available cluster version. properties: properties: x-ms-client-flatten: true description: Cluster version properties. $ref: '#/definitions/ClusterVersionProperties' allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource MigrateProjectProperties: type: object description: Properties of a migrate project. properties: registeredTools: type: array description: Register tools inside project. items: enum: - ServerDiscovery - ServerAssessment - ServerMigration - Cloudamize - Turbonomic - Zerto - CorentTech - ServerAssessmentV1 - ServerMigration_Replication - Carbonite - DataMigrationAssistant - DatabaseMigrationService - Device42 - JetStream - RackWare - UnifyCloud - Flexera - ServerDiscovery_Import - Lakeside - AppServiceMigrationAssistant - Movere - CloudSphere - Modernization - ServerMigration_DataReplication - Unknown type: string x-ms-enum: name: items modelAsString: true readOnly: true serviceEndpoint: type: string description: Service endpoint. summary: type: object description: Project summary. additionalProperties: $ref: '#/definitions/ProjectSummary' readOnly: true lastSummaryRefreshedTime: format: date-time type: string description: Last summary refresh time. readOnly: true refreshSummaryState: enum: - Started - InProgress - Completed - Failed type: string description: Refresh summary state. readOnly: true x-ms-enum: name: refreshSummaryState modelAsString: true utilityStorageAccountId: type: string description: Utility storage account id. publicNetworkAccess: description: Gets or sets the state of public network access. enum: - NotSpecified - Enabled - Disabled x-ms-enum: name: publicNetworkAccess modelAsString: true type: string privateEndpointConnections: description: Gets the private endpoint connections. type: array items: $ref: '#/definitions/PrivateEndpointConnection_2' readOnly: true TypedErrorInfo: description: Scenario specific error details. properties: type: description: The type of included error details. type: string readOnly: true info: description: The scenario specific error details. readOnly: true AgentOptions: type: object title: AgentOptions are configurations that will be applied to each agent in an agent pool. required: - hugepagesCount properties: hugepagesCount: description: The number of hugepages to allocate. type: integer format: int64 hugepagesSize: description: The size of the hugepages to allocate. type: string default: 2M enum: - 2M - 1G x-ms-enum: modelAsString: true name: HugepagesSize x-ms-mutability: - read - create PolicyDetails: type: object description: The policy details. properties: policyDefinitionId: description: The ID of the policy definition. type: string readOnly: true policyAssignmentId: description: The ID of the policy assignment. type: string readOnly: true policyAssignmentDisplayName: description: The display name of the policy assignment. type: string readOnly: true policyAssignmentScope: description: The scope of the policy assignment. type: string readOnly: true policySetDefinitionId: description: The ID of the policy set definition. type: string readOnly: true policyDefinitionReferenceId: description: The policy definition reference ID within the policy set definition. type: string readOnly: true ConsoleList: type: object title: ConsoleList represents a list of virtual machine consoles. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of virtual machine consoles. type: array items: $ref: '#/definitions/Console' CheckNameAvailabilityResponseBody: description: The response body returned for a request to check availability of a bot name. type: object properties: nameAvailable: description: indicates if the bot name is valid and available. type: boolean reason: description: Reason for the result type: string message: description: additional message from server type: string AzureMonitorPrivateLinkScope: properties: properties: x-ms-client-flatten: true description: Properties that define a Azure Monitor PrivateLinkScope resource. $ref: '#/definitions/AzureMonitorPrivateLinkScopeProperties' systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: System data readOnly: true allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource required: - properties description: An Azure Monitor PrivateLinkScope definition. NameAvailabilityResult: description: Result of check name availability. type: object properties: nameAvailable: type: boolean description: Indicator of availability of the Microsoft.HDInsight resource name. reason: type: string description: The reason of unavailability. message: type: string description: The error message of unavailability. GitHubConnectorStats: type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/GitHubConnectorStatsProperties' EncryptionWithCmk: type: object properties: enforcement: description: Describes how a search service should enforce having one or more non customer encrypted resources. type: string enum: - Disabled - Enabled - Unspecified x-ms-enum: name: SearchEncryptionWithCmk modelAsString: false values: - value: Disabled name: Disabled description: No enforcement will be made and the search service can have non customer encrypted resources. - value: Enabled name: Enabled description: Search service will be marked as non-compliant if there are one or more non customer encrypted resources. - value: Unspecified name: Unspecified description: Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. encryptionComplianceStatus: readOnly: true description: Describes whether the search service is compliant or not with respect to having non customer encrypted resources. If a service has more than one non customer encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'. type: string enum: - Compliant - NonCompliant x-ms-enum: name: SearchEncryptionComplianceStatus modelAsString: false values: - value: Compliant name: Compliant description: Indicates that the search service is compliant, either because number of non customer encrypted resources is zero or enforcement is disabled. - value: NonCompliant name: NonCompliant description: Indicates that the search service has more than 1 non customer encrypted resources. description: Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys. Port: description: The port exposed on the container group. type: object properties: protocol: type: string description: The protocol associated with the port. enum: - TCP - UDP x-ms-enum: name: ContainerGroupNetworkProtocol modelAsString: true port: type: integer description: The port number. format: int32 required: - port AccountEncryption: properties: type: type: string enum: - SystemKey - CustomerKey x-ms-enum: name: AccountEncryptionKeyType values: - value: SystemKey description: The Account Key is encrypted with a System Key. - value: CustomerKey description: The Account Key is encrypted with a Customer Key. modelAsString: true description: The type of key used to encrypt the Account Key. keyVaultProperties: $ref: '#/definitions/KeyVaultProperties_2' description: The properties of the key used to encrypt the account. identity: $ref: '#/definitions/ResourceIdentity' description: The Key Vault identity. status: type: string description: The current status of the Key Vault mapping. readOnly: true type: object required: - type description: Defines how the Video Analyzer account is (optionally) encrypted. subscriber: type: object properties: email: type: string description: Email of the subscriber notifications: type: integer format: int64 description: Number specifying what notifications to receive ComponentExpressionEvaluationDetails: type: object description: Evaluation details of policy language expressions. properties: result: description: Evaluation result. type: string expression: description: Expression evaluated. type: string readOnly: true expressionKind: description: The kind of expression that was evaluated. type: string readOnly: true path: description: Property path if the expression is a field or an alias. type: string readOnly: true expressionValue: description: Value of the expression. type: object readOnly: true targetValue: description: Target value to be compared with the expression value. type: object readOnly: true operator: description: Operator to compare the expression value and the target value. type: string readOnly: true MigrateProject: type: object x-ms-azure-resource: true description: Migrate project. properties: properties: $ref: '#/definitions/MigrateProjectProperties' eTag: type: string description: For optimistic concurrency control. location: type: string description: Azure location in which project is created. x-ms-mutability: - create - read id: type: string description: Path reference to this project /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName} readOnly: true name: type: string description: Name of the project. readOnly: true type: type: string description: Type of the object = [Microsoft.Migrate/migrateProjects]. readOnly: true systemData: $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/systemData readOnly: true PrivateLinkServiceProxy: description: Private link service proxy details. type: object properties: id: description: NRP resource ID. type: string remotePrivateLinkServiceConnectionState: description: Remote private link service connection state $ref: ./privatelinks.json#/definitions/PrivateLinkServiceConnectionState remotePrivateEndpointConnection: description: Remote private endpoint connection details. allOf: - $ref: '#/definitions/RemotePrivateEndpointConnection' groupConnectivityInformation: description: Group connectivity information. type: array items: $ref: '#/definitions/GroupConnectivityInformation' ScheduleAvailabilityRequest: description: Request body to get the availability for scheduling orders. required: - storageLocation - skuName type: object properties: storageLocation: description: 'Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01' type: string skuName: description: Sku Name for which the order is to be scheduled. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: SkuName modelAsExtensible: true values: - value: DataBox description: Data Box. - value: DataBoxDisk description: Data Box Disk. - value: DataBoxHeavy description: Data Box Heavy. - value: DataBoxCustomerDisk description: Data Box Customer Disk. country: description: Country in which storage location should be supported. type: string discriminator: skuName SummarizeResults: description: Summarize action results. properties: '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string '@odata.count': description: OData entity count; represents the number of summaries returned; always set to 1. type: integer format: int32 minimum: 1 maximum: 1 value: description: Summarize action results. type: array items: $ref: '#/definitions/Summary' BareMetalMachineRunDataExtractsParameters: type: object title: BareMetalMachineRunDataExtractsParameters represents the body of request containing list of curated data extraction commands to run on the bare metal machine. required: - commands - limitTimeSeconds properties: commands: description: The list of curated data extraction commands to be executed directly against the target machine. type: array minItems: 1 items: $ref: '#/definitions/BareMetalMachineCommandSpecification' x-ms-identifiers: [] limitTimeSeconds: description: 'The maximum time the commands are allowed to run. If the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).' type: integer format: int64 maximum: 14400 minimum: 60 BareMetalMachineProperties: type: object title: BareMetalMachineProperties represents the properties of a bare metal machine. required: - rackId - machineSkuId - rackSlot - machineName - bootMacAddress - bmcMacAddress - bmcCredentials - bmcConnectionString - machineDetails - serialNumber properties: associatedResourceIds: description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. type: array items: type: string readOnly: true bmcConnectionString: description: The connection string for the baseboard management controller including IP address and protocol. type: string bmcCredentials: $ref: '#/definitions/AdministrativeCredentials' description: The credentials of the baseboard management controller on this bare metal machine. bmcMacAddress: description: The MAC address of the BMC device. type: string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ bootMacAddress: description: The MAC address of a NIC connected to the PXE network. type: string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ clusterId: description: The resource ID of the cluster this bare metal machine is associated with. type: string format: arm-id readOnly: true cordonStatus: description: The cordon status of the bare metal machine. type: string enum: - Cordoned - Uncordoned x-ms-enum: modelAsString: true name: BareMetalMachineCordonStatus readOnly: true detailedStatus: description: The more detailed status of the bare metal machine. type: string enum: - Preparing - Error - Available - Provisioning - Provisioned - Deprovisioning x-ms-enum: modelAsString: true name: BareMetalMachineDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true hardwareInventory: $ref: '#/definitions/HardwareInventory' description: The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. readOnly: true hardwareValidationStatus: $ref: '#/definitions/HardwareValidationStatus' description: The details of the latest hardware validation performed for this bare metal machine. readOnly: true hybridAksClustersAssociatedIds: description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. type: array items: type: string readOnly: true kubernetesNodeName: description: The name of this machine represented by the host object in the Cluster's Kubernetes control plane. type: string readOnly: true kubernetesVersion: description: The version of Kubernetes running on this machine. type: string readOnly: true machineDetails: description: The custom details provided by the customer. type: string maxLength: 256 machineName: description: The OS-level hostname assigned to this machine. type: string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ machineRoles: description: The list of roles that are assigned to the cluster node running on this machine. type: array items: type: string readOnly: true machineSkuId: description: The unique internal identifier of the bare metal machine SKU. type: string oamIpv4Address: description: The IPv4 address that is assigned to the bare metal machine during the cluster deployment. type: string readOnly: true oamIpv6Address: description: The IPv6 address that is assigned to the bare metal machine during the cluster deployment. type: string readOnly: true osImage: description: The image that is currently provisioned to the OS disk. type: string readOnly: true powerState: description: The power state derived from the baseboard management controller. type: string enum: - 'On' - 'Off' x-ms-enum: modelAsString: true name: BareMetalMachinePowerState readOnly: true provisioningState: description: The provisioning state of the bare metal machine. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted x-ms-enum: modelAsString: true name: BareMetalMachineProvisioningState readOnly: true rackId: description: The resource ID of the rack where this bare metal machine resides. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.NetworkCloud/racks rackSlot: description: The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. type: integer format: int64 maximum: 256 minimum: 1 readyState: description: The indicator of whether the bare metal machine is ready to receive workloads. type: string enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: BareMetalMachineReadyState readOnly: true runtimeProtectionStatus: $ref: '#/definitions/RuntimeProtectionStatus' description: The runtime protection status of the bare metal machine. readOnly: true serialNumber: description: The serial number of the bare metal machine. type: string maxLength: 64 minLength: 1 serviceTag: description: The discovered value of the machine's service tag. type: string readOnly: true virtualMachinesAssociatedIds: description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. type: array items: type: string readOnly: true AgentPool: type: object title: AgentPool represents the agent pool of Kubernetes cluster. required: - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/AgentPoolProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true PremierAddOnOfferCollection: description: Collection of premier add-on offers. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/PremierAddOnOffer' nextLink: description: Link to next page of resources. type: string readOnly: true flowTypes: type: array description: The flow types that are allowed for this resource items: $ref: '#/definitions/flowType' ProjectResultList: type: object description: List of projects. properties: value: type: array description: List of projects. items: $ref: '#/definitions/Project' ProxyResource: type: object properties: id: readOnly: true type: string description: The ID of the resource. name: readOnly: true type: string description: The name of the resource. type: readOnly: true type: string description: The type of the resource. etag: readOnly: true type: string description: The ETag of the resource, used for concurrency statements. description: A definition of an Azure resource. x-ms-azure-resource: true BareMetalMachineKeySetPatchParameters: type: object title: BareMetalMachineKeySetPatchParameters represents the body of the request to patch the bare metal machine key set. properties: properties: $ref: '#/definitions/BareMetalMachineKeySetPatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string SessionStatus: type: string description: The status of the session. enum: - Waiting - Executing - Succeeded - Failed - Failure(s) - TimedOut x-ms-enum: name: SessionStatus modelAsString: true values: - name: Waiting value: Waiting description: The session is waiting in the queue to be executed. - name: Executing value: Executing description: The session is being executed. - name: Succeeded value: Succeeded description: The session completed with success. - name: Failed value: Failed description: The session completed with failure. - name: Failure(s) value: Failure(s) description: The session completed with some failures. - name: TimedOut value: TimedOut description: The session timed out. AccountStatus: description: Account status. type: object properties: scopesStatuses: description: The list of scopes statuses. type: array items: $ref: '#/definitions/ScopeStatuses' x-ms-identifiers: [] SharedPrivateLinkResource: properties: properties: $ref: '#/definitions/SharedPrivateLinkResourceProperties' description: Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service. allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/Resource description: Describes a Shared Private Link Resource managed by the Azure Cognitive Search service. StorageApplianceConfigurationData: type: object title: StorageApplianceConfigurationData represents configuration for the storage application. required: - rackSlot - adminCredentials - serialNumber properties: adminCredentials: $ref: '#/definitions/AdministrativeCredentials' description: The credentials of the administrative interface on this storage appliance. rackSlot: description: The slot that storage appliance is in the rack based on the BOM configuration. type: integer format: int64 maximum: 256 minimum: 1 serialNumber: description: The serial number of the appliance. type: string storageApplianceName: description: The user-provided name for the storage appliance that will be created from this specification. type: string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ ClusterMetricsConfigurationProperties: type: object title: ClusterMetricsConfigurationProperties represents the properties of metrics configuration for the cluster. required: - collectionInterval properties: collectionInterval: description: The interval in minutes by which metrics will be collected. type: integer format: int64 maximum: 1440 minimum: 1 detailedStatus: description: The more detailed status of the metrics configuration. type: string enum: - Processing - Applied - Error x-ms-enum: modelAsString: true name: ClusterMetricsConfigurationDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true disabledMetrics: description: The list of metrics that are available for the cluster but disabled at the moment. type: array items: type: string readOnly: true enabledMetrics: description: The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. type: array items: type: string provisioningState: description: The provisioning state of the metrics configuration. type: string enum: - Succeeded - Failed - Canceled - Accepted - Provisioning x-ms-enum: modelAsString: true name: ClusterMetricsConfigurationProvisioningState readOnly: true ActionableRemediation: type: object properties: state: $ref: '#/definitions/ActionableRemediationState' severityLevels: type: array items: type: string x-ms-identifiers: [] categories: type: array items: $ref: '#/definitions/RuleCategory' x-ms-identifiers: [] branchConfiguration: $ref: '#/definitions/TargetBranchConfiguration' ClusterServiceConfig: type: object description: Cluster configs per component. required: - component - files properties: component: type: string description: Name of the component the config files should apply to. files: type: array description: List of Config Files. items: $ref: '#/definitions/ClusterConfigFile' x-ms-identifiers: [] AzureFunctionReceiver: description: An azure function receiver. type: object properties: name: type: string description: The name of the azure function receiver. Names must be unique across all receivers within an action group. functionAppResourceId: type: string description: The azure resource id of the function app. functionName: type: string description: The function name in the function app. httpTriggerUrl: type: string description: The http trigger url where http request sent to. useCommonAlertSchema: type: boolean default: false description: Indicates whether to use common alert schema. required: - name - functionAppResourceId - functionName - httpTriggerUrl VNetSolution: type: object description: The VNet solution for linker properties: type: x-nullable: true description: Type of VNet solution. type: string enum: - serviceEndpoint - privateLink x-ms-enum: name: vNetSolutionType modelAsString: true deleteOrUpdateBehavior: description: Indicates whether to clean up previous operation when Linker is updating or deleting $ref: '#/definitions/DeleteOrUpdateBehavior' OldAgreementTerms: type: object properties: properties: $ref: '#/definitions/OldAgreementProperties' description: Represents the properties of the resource. x-ms-client-flatten: true allOf: - $ref: '#/definitions/Resource_8' description: Terms properties for provided Publisher/Offer/Plan tuple CloudServicesNetworkPatchProperties: type: object title: CloudServicesNetworkPatchProperties represents the properties of the cloud services network that can be updated using a patch request. properties: additionalEgressEndpoints: description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. type: array items: $ref: '#/definitions/EgressEndpoint' x-ms-identifiers: [] enableDefaultEgressEndpoints: description: The indicator of whether the platform default endpoints are allowed for the egress traffic. type: string default: 'True' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: CloudServicesNetworkEnableDefaultEgressEndpoints EffectiveRouteMapRouteList: description: EffectiveRouteMapRoute List. type: object properties: value: type: array items: $ref: '#/definitions/EffectiveRouteMapRoute' description: The list of Effective RouteMap Routes configured on the connection resource. x-ms-identifiers: [] PeerRoute: properties: localAddress: type: string readOnly: true description: The peer's local address. network: type: string readOnly: true description: The route's network prefix. nextHop: type: string readOnly: true description: The route's next hop. sourcePeer: type: string readOnly: true description: The peer this route was learned from. origin: type: string readOnly: true description: The source this route was learned from. asPath: type: string readOnly: true description: The route's AS path sequence. weight: type: integer format: int32 readOnly: true description: The route's weight. description: Peer routing details. errorDetail: title: Error details. type: object properties: code: description: The error's code. type: string message: description: A human readable error message. type: string target: description: Indicates which property in the request is responsible for the error. type: string value: description: Indicates which value in 'target' is responsible for the error. type: string resources: description: Indicates resources which were responsible for the error. type: array items: type: string additionalProperties: type: object required: - code - message CencDrmConfiguration: properties: playReady: $ref: '#/definitions/StreamingPolicyPlayReadyConfiguration' description: PlayReady configurations widevine: $ref: '#/definitions/StreamingPolicyWidevineConfiguration' description: Widevine configurations type: object description: Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy VirtualHubEffectiveRouteList: description: EffectiveRoutes List. properties: value: type: array items: $ref: '#/definitions/VirtualHubEffectiveRoute' description: The list of effective routes configured on the virtual hub or the specified resource. GitHubRepo: description: GitHub repo Proxy Resource. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/GitHubRepoProperties' ProviderStatus: type: object description: Provider status. properties: id: type: string description: Provider id. readOnly: true currentAvailability: $ref: '#/definitions/ProviderAvailability' description: Current provider availability. readOnly: true targets: type: array description: Current target statuses. items: $ref: '#/definitions/TargetStatus' readOnly: true required: - id - currentAvailability - targets JsonPatchOperation: type: string description: The operation to be performed. enum: - add - remove - replace - move - copy - test x-ms-enum: name: JsonPatchOperation modelAsString: true values: - name: add value: add description: Add value operation. - name: remove value: remove description: Remove value operation. - name: replace value: replace description: Replace value operation. - name: move value: move description: Move value operation. - name: copy value: copy description: Copy value operation. - name: test value: test description: Test value operation. ValidateResponse: description: Describes the result of resource validation. type: object properties: status: description: Result of validation. type: string error: $ref: '#/definitions/ValidateResponseError' description: Error details for the case when validation fails. MachineSkuProperties: type: object title: MachineSkuProperties represents the properties of the machine SKU. properties: bootstrapProtocol: description: The type of bootstrap protocol used. type: string enum: - PXE x-ms-enum: modelAsString: true name: BootstrapProtocol readOnly: true cpuCores: description: The count of CPU cores for this machine. type: integer format: int64 readOnly: true cpuSockets: description: The count of CPU sockets for this machine. type: integer format: int64 readOnly: true disks: description: The list of disks. type: array items: $ref: '#/definitions/MachineDisk' x-ms-identifiers: [] readOnly: true generation: description: The generation of the architecture. type: string readOnly: true hardwareVersion: description: The hardware version of the machine. type: string readOnly: true memoryCapacityGB: description: The maximum amount of memory in GB. type: integer format: int64 readOnly: true model: description: The model of the machine. type: string readOnly: true networkInterfaces: description: The list of network interfaces. type: array items: $ref: '#/definitions/NetworkInterface' x-ms-identifiers: [] readOnly: true totalThreads: description: The count of SMT and physical core threads for this machine. type: integer format: int64 readOnly: true vendor: description: The make of the machine. type: string readOnly: true ValidationResponse: description: Response of pre job creation validations. type: object properties: properties: $ref: '#/definitions/ValidationResponseProperties' description: Properties of pre job creation validation response. readOnly: true x-ms-client-flatten: true KubernetesClusterList: type: object title: KubernetesClusterList represents a list of Kubernetes clusters. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of additional details related to Kubernetes clusters. type: array items: $ref: '#/definitions/KubernetesCluster' GroupConnectivityInformation: description: Group connectivity details. type: object properties: groupId: description: Group ID. type: string readOnly: true memberName: description: Member name. type: string readOnly: true customerVisibleFqdns: description: List of customer visible FQDNs. type: array items: type: string internalFqdn: description: Internal FQDN. type: string readOnly: true redirectMapId: description: Redirect map ID. type: string privateLinkServiceArmRegion: description: PrivateLinkService ARM region. type: string ClusterPoolResourceProperties: type: object required: - computeProfile properties: provisioningState: description: Provisioning state of the resource. type: string enum: - Accepted - Succeeded - Canceled - Failed x-ms-enum: name: ProvisioningStatus modelAsString: true readOnly: true deploymentId: type: string description: A unique id generated by the RP to identify the resource. example: 45cd32aead6e4a91b079a0cdbfac8c36 readOnly: true managedResourceGroupName: type: string description: 'A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction.' minLength: 1 maxLength: 40 example: hdi-45cd32aead6e4a91b079a0cdbfac8c36 aksManagedResourceGroupName: type: string description: 'A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}' readOnly: true example: MC_hdi-45cd32aead6e4a91b079a0cdbfac8c36_test-pool_eastus clusterPoolProfile: description: CLuster pool profile. allOf: - $ref: '#/definitions/ClusterPoolProfile' computeProfile: description: CLuster pool compute profile. allOf: - $ref: '#/definitions/ClusterPoolComputeProfile' aksClusterProfile: description: Properties of underlying AKS cluster. readOnly: true allOf: - $ref: '#/definitions/AksClusterProfile' networkProfile: description: Cluster pool network profile. allOf: - $ref: '#/definitions/ClusterPoolNetworkProfile' logAnalyticsProfile: description: Cluster pool log analytics profile to enable OMS agent for AKS cluster. allOf: - $ref: '#/definitions/ClusterPoolLogAnalyticsProfile' status: type: string description: Business status of the resource. example: Running readOnly: true description: Cluster pool resource properties. GraphQueryResource: description: Graph Query entity definition. allOf: - $ref: '#/definitions/Resource_2' properties: properties: x-ms-client-flatten: true description: Metadata describing a graph query for an Azure resource. $ref: '#/definitions/GraphQueryProperties' tags: type: object additionalProperties: type: string description: Resource tags systemData: readOnly: true $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData etag: type: string description: This will be used to handle Optimistic Concurrency. VirtualHubRouteTableV2: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VirtualHubRouteTableV2Properties' description: Properties of the virtual hub route table v2. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. allOf: - $ref: ./network.json#/definitions/SubResource description: VirtualHubRouteTableV2 Resource. AccessPolicyEntity: allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/AccessPolicyProperties' description: The resource properties. x-ms-client-flatten: true type: object description: Access policies help define the authentication rules, and control access to specific video resources. ResourceList: description: The list of Linker. type: object properties: nextLink: x-nullable: true description: The Linker used to get the next page of Linker list. type: string value: description: The list of Linkers. type: array items: $ref: '#/definitions/LinkerResource' ConnectionDetails: description: Private endpoint connection proxy object properties. type: object properties: id: description: Connection details ID. type: string readOnly: true privateIpAddress: description: Private IP address. type: string readOnly: true linkIdentifier: description: Link ID. type: string readOnly: true groupId: description: Group ID. type: string readOnly: true memberName: description: Member name. type: string readOnly: true ListContentKeysResponse: properties: contentKeys: type: array items: $ref: '#/definitions/StreamingLocatorContentKey' description: ContentKeys used by current Streaming Locator type: object description: Class of response for listContentKeys action ServiceResourceProperties: description: This type describes properties of a service resource. allOf: - $ref: '#/definitions/ServiceReplicaProperties' - type: object properties: description: description: User readable description of the service. type: string replicaCount: type: integer description: The number of replicas of the service to create. Defaults to 1 if not specified. healthState: $ref: '#/definitions/HealthState_2' description: The health state of a resource such as Application, Service, or Network. status: readOnly: true type: string description: Represents the status of the service. enum: - Unknown - Active - Upgrading - Deleting - Creating - Failed x-ms-enum: name: ServiceResourceStatus modelAsString: true GuestDiagnosticSettingsAssociationList: description: A list of guest diagnostic settings association. properties: value: type: array items: $ref: '#/definitions/GuestDiagnosticSettingsAssociationResource' description: The list of guest diagnostic settings association. nextLink: type: string description: Provides the link to retrieve the next set of elements. patchServersResponseProperties: type: object description: Properties for patching servers properties: status: description: Status of the patch operation type: string PolicyStatesQueryResults: description: Query results. properties: '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string '@odata.count': description: OData entity count; represents the number of policy state records returned. type: integer format: int32 minimum: 0 '@odata.nextLink': description: Odata next link; URL to get the next set of results. type: string value: description: Query results. type: array items: $ref: '#/definitions/PolicyState' UserAssignedManagedIdentity_2: properties: principalId: readOnly: true type: string description: The principal ID of user assigned identity. clientId: readOnly: true type: string description: The client ID of user assigned identity. type: object description: The details of the user assigned managed identity assigned to the search service. KubernetesConfigurationPrivateLinkScopeProperties: type: object description: Properties that define a Azure Arc PrivateLinkScope resource. required: - clusterResourceId properties: publicNetworkAccess: description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. $ref: '#/definitions/PublicNetworkAccessType_3' provisioningState: description: 'Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.' type: string readOnly: true $ref: ../../common/2022-03-01/definitions.json#/definitions/ProvisioningStateDefinition clusterResourceId: type: string description: Managed Cluster ARM ID for the private link scope (Required) privateLinkScopeId: readOnly: true description: The Guid id of the private link scope. type: string privateEndpointConnections: readOnly: true description: The collection of associated Private Endpoint Connections. type: array items: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection ConnectivityProfile: type: object description: Cluster connectivity profile. required: - web properties: web: description: Web connectivity endpoint details. allOf: - $ref: '#/definitions/WebConnectivityEndpoint' ssh: type: array description: List of SSH connectivity endpoints. items: $ref: '#/definitions/SshConnectivityEndpoint' x-ms-identifiers: [] readOnly: true ActionGroupPatch: description: An Azure action group for patch operations. type: object properties: enabled: type: boolean default: true description: Indicates whether this action group is enabled. If an action group is not enabled, then none of its actions will be activated. errorResponse: title: Error details. description: Contains details when the response code indicates an error. type: object properties: error: description: The error details. $ref: '#/definitions/errorInfo' required: - error StorageProfile_2: type: object title: StorageProfile represents information about a disk. required: - osDisk properties: osDisk: $ref: '#/definitions/OsDisk' description: The disk to use with this virtual machine. volumeAttachments: description: The resource IDs of volumes that are requested to be attached to the virtual machine. type: array items: type: string AppRoleAssignmentHealthReport: description: A report of the health status of an AppRoleAssignment. type: object properties: appRoleAssignment: description: The permission description. $ref: '#/definitions/AppRoleAssignmentDefinition' status: description: The health status for the permission. $ref: '#/definitions/HealthStatus' ListSkusResult: description: List of available SKUs for a new Kusto Cluster. type: object properties: value: type: array items: $ref: '#/definitions/AzureSku' description: The collection of available SKUs for new resources. ModelingPatchResource: description: Modeling resource patch details. type: object properties: tags: description: Resource tags. $ref: '#/definitions/Tags' properties: description: Modeling resource properties to update. type: object properties: inputData: description: The configuration to raw CDM data to be used as Modeling resource input. $ref: '#/definitions/ModelingInputData' Summary: description: Summary results. properties: '@odata.id': description: OData entity ID; always set to null since summaries do not have an entity ID. type: string '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string results: description: Non-compliance summary for all policy assignments. $ref: '#/definitions/SummaryResults' policyAssignments: description: Policy assignments summary. type: array items: $ref: '#/definitions/PolicyAssignmentSummary' PerimeterAssociableResourcesListResult: type: object properties: value: type: array items: $ref: '#/definitions/PerimeterAssociableResource' description: Gets paged list of perimeter associable resources. nextLink: type: string description: Gets the URL to get the next page of results. description: Paged list of perimeter associable resources. AzureAppPushReceiver: description: The Azure mobile App push notification receiver. type: object properties: name: type: string description: The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group. emailAddress: type: string description: The email address registered for the Azure mobile app. required: - name - emailAddress ListVpnSiteLinksResult: description: Result of the request to list VpnSiteLinks. It contains a list of VpnSiteLinks and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnSiteLink' description: List of VpnSitesLinks. nextLink: type: string description: URL to get the next set of operation list results if there are any. BareMetalMachinePatchProperties: type: object title: BareMetalMachinePatchProperties represents the properties of the bare metal machine that can be patched. properties: machineDetails: description: 'The details provided by the customer during the creation of rack manifests that allows for custom data to be associated with this machine.' type: string maxLength: 256 CbcsDrmConfiguration: properties: fairPlay: $ref: '#/definitions/StreamingPolicyFairPlayConfiguration' description: FairPlay configurations playReady: $ref: '#/definitions/StreamingPolicyPlayReadyConfiguration' description: PlayReady configurations widevine: $ref: '#/definitions/StreamingPolicyWidevineConfiguration' description: Widevine configurations type: object description: Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy HealthBotKey: type: object description: An entry of HealthBotKeysResponse properties: keyName: type: string description: The name of the key. value: type: string x-ms-secret: true description: The value of the key. ClusterMetricsConfigurationList: type: object title: ClusterMetricsConfigurationList represents a list of metrics configuration of the cluster. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of metrics configurations. type: array items: $ref: '#/definitions/ClusterMetricsConfiguration' ValidateRequest: description: Resource validation request content. required: - name - type - location - properties type: object properties: name: description: Resource name to verify. type: string type: description: Resource type used for verification. enum: - ServerFarm - Site - Microsoft.Web/hostingEnvironments type: string x-ms-enum: name: ValidateResourceTypes modelAsString: true location: description: Expected location of the resource. type: string properties: $ref: '#/definitions/ValidateProperties' description: Properties of the resource to validate. x-ms-client-flatten: true ClusterCapacity: type: object title: ClusterCapacity represents various details regarding compute capacity. properties: availableApplianceStorageGB: description: The remaining appliance-based storage in GB available for workload use. type: integer format: int64 availableCoreCount: description: The remaining number of cores that are available in this cluster for workload use. type: integer format: int64 availableHostStorageGB: description: The remaining machine or host-based storage in GB available for workload use. type: integer format: int64 availableMemoryGB: description: The remaining memory in GB that are available in this cluster for workload use. type: integer format: int64 totalApplianceStorageGB: description: The total appliance-based storage in GB supported by this cluster for workload use. type: integer format: int64 totalCoreCount: description: The total number of cores that are supported by this cluster for workload use. type: integer format: int64 totalHostStorageGB: description: The total machine or host-based storage in GB supported by this cluster for workload use. type: integer format: int64 totalMemoryGB: description: The total memory supported by this cluster for workload use. type: integer format: int64 eventsOperationInfo: description: Operation info for an event result type: object properties: name: description: Name of the operation type: string id: description: ID of the operation type: string parentId: description: Parent ID of the operation type: string syntheticSource: description: Synthetic source of the operation type: string BareMetalMachine: type: object title: BareMetalMachine represents the physical machine in the rack. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/BareMetalMachineProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true Location: type: object properties: name: type: string role: description: Whether the location is primary or failover default: Primary enum: - Primary - Failover type: string x-ms-enum: name: Role modelAsString: true additionalProperties: false ContainerExecRequest: description: The container exec request. type: object properties: command: type: string description: The command to be executed. terminalSize: type: object description: The size of the terminal. properties: rows: type: integer format: int32 description: The row size of the terminal cols: type: integer format: int32 description: The column size of the terminal ListVpnSitesResult: description: Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnSite' description: List of VpnSites. nextLink: type: string description: URL to get the next set of operation list results if there are any. JsonPatchObject: type: object description: A JSONPatch object as defined by RFC 6902. properties: op: $ref: '#/definitions/JsonPatchOperation' description: The operation to be performed. x-ms-client-name: operation x-ms-mutability: - create path: type: string description: A JSON-Pointer. x-ms-mutability: - create value: type: object description: A value to be used in the operation on the path. x-ms-mutability: - create from: type: string description: Optional field used in copy and move operations. x-ms-mutability: - create required: - op - path AttestationProperties: properties: policyAssignmentId: type: string description: The resource ID of the policy assignment that the attestation is setting the state for. policyDefinitionReferenceId: type: string description: The policy definition reference ID from a policy set definition that the attestation is setting the state for. If the policy assignment assigns a policy set definition the attestation can choose a definition within the set definition with this property or omit this and set the state for the entire set definition. complianceState: type: string enum: - Compliant - NonCompliant - Unknown x-ms-enum: name: ComplianceState modelAsString: true values: - value: Compliant description: The resource is in compliance with the policy. - value: NonCompliant description: The resource is not in compliance with the policy. - value: Unknown description: The compliance state of the resource is not known. description: The compliance state that should be set on the resource. expiresOn: type: string format: date-time description: The time the compliance state should expire. owner: type: string description: The person responsible for setting the state of the resource. This value is typically an Azure Active Directory object ID. comments: type: string description: Comments describing why this attestation was created. evidence: type: array items: $ref: '#/definitions/AttestationEvidence' x-ms-identifiers: [] description: The evidence supporting the compliance state set in this attestation. provisioningState: type: string description: The status of the attestation. readOnly: true lastComplianceStateChangeAt: type: string format: date-time description: The time the compliance state was last changed in this attestation. readOnly: true assessmentDate: type: string format: date-time description: The time the evidence was assessed metadata: type: object description: Additional metadata for this attestation required: - policyAssignmentId description: The properties of an attestation resource. ListVirtualHubIpConfigurationResults: properties: value: type: array items: $ref: '#/definitions/HubIpConfiguration' description: The list of VirtualHubIpConfigurations. nextLink: type: string description: URL to get the next set of results. description: VirtualHubIpConfigurations list. GitHubOwner: description: GitHub repo owner Proxy Resource. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/GitHubOwnerProperties' SshConnectivityEndpoint: type: object description: SSH connectivity endpoint details. required: - endpoint properties: endpoint: type: string description: SSH connectivity endpoint. example: clusterName11223344.clusterPoolName55667788.eastus.hdinsightaks.net/ssh/host/podPrefix-0 EventHubReceiver: description: An Event hub receiver. type: object properties: name: type: string description: The name of the Event hub receiver. Names must be unique across all receivers within an action group. eventHubNameSpace: type: string description: The Event Hub namespace eventHubName: type: string description: The name of the specific Event Hub queue useCommonAlertSchema: type: boolean default: false description: Indicates whether to use common alert schema. tenantId: type: string description: The tenant Id for the subscription containing this event hub subscriptionId: type: string description: The Id for the subscription containing this event hub required: - name - eventHubNameSpace - eventHubName - subscriptionId ShippingAddress: description: Shipping address where customer wishes to receive the device. required: - streetAddress1 - country type: object properties: streetAddress1: description: Street Address line 1. type: string streetAddress2: description: Street Address line 2. type: string streetAddress3: description: Street Address line 3. type: string city: description: Name of the City. type: string stateOrProvince: description: Name of the State or Province. type: string country: description: Name of the Country. type: string postalCode: description: Postal code. type: string zipExtendedCode: description: Extended Zip Code. type: string companyName: description: Name of the company. type: string addressType: description: Type of address. enum: - None - Residential - Commercial type: string x-ms-enum: name: AddressType modelAsExtensible: true values: - value: None description: Address type not known. - value: Residential description: Residential Address. - value: Commercial description: Commercial Address. default: None skipAddressValidation: type: boolean description: Flag to indicate if customer has chosen to skip default address validation taxIdentificationNumber: type: string description: Tax Identification Number metricsResultInfo: description: A metric result data. type: object properties: start: description: Start time of the metric. type: string format: date_time end: description: Start time of the metric. type: string format: date_time interval: description: The interval used to segment the metric data. type: string format: duration segments: description: Segmented metric data (if segmented). type: array items: $ref: '#/definitions/metricsSegmentInfo' additionalProperties: description: Additional properties that can be provided on the metric result info type: object PrivateLinkScopesResource: type: object properties: id: type: string readOnly: true description: Azure resource Id name: type: string description: Azure resource name readOnly: true type: type: string readOnly: true description: Azure resource type location: type: string description: Resource location x-ms-mutability: - create - read tags: type: object additionalProperties: type: string description: Resource tags required: - location x-ms-azure-resource: true description: An azure resource object eventsCloudInfo: description: Cloud info for an event result type: object properties: roleName: description: Role name of the cloud type: string roleInstance: description: Role instance of the cloud type: string Disk: type: object description: A disk discovered on a machine. properties: gigabytesAllocated: type: number format: double description: Gigabytes of storage provisioned for this disk. readOnly: true gigabytesConsumed: format: double type: number description: Gigabytes of storage consumed by this disk. readOnly: true ClusterProfile: type: object required: - identityProfile - authorizationProfile - clusterVersion - ossVersion properties: clusterVersion: $ref: '#/definitions/ThreeOrFourPartVersionPattern' ossVersion: $ref: '#/definitions/ThreePartVersionPattern' components: $ref: '#/definitions/ClusterComponents' identityProfile: $ref: '#/definitions/IdentityProfile' authorizationProfile: $ref: '#/definitions/AuthorizationProfile' secretsProfile: $ref: '#/definitions/SecretsProfile' serviceConfigsProfiles: type: array description: The service configs profiles. items: $ref: '#/definitions/ClusterServiceConfigsProfile' x-ms-identifiers: [] connectivityProfile: $ref: '#/definitions/ConnectivityProfile' logAnalyticsProfile: $ref: '#/definitions/ClusterLogAnalyticsProfile' prometheusProfile: $ref: '#/definitions/ClusterPrometheusProfile' sshProfile: $ref: '#/definitions/SshProfile' autoscaleProfile: $ref: '#/definitions/AutoscaleProfile' kafkaProfile: type: object description: Kafka cluster profile. additionalProperties: true trinoProfile: $ref: '#/definitions/TrinoProfile' llapProfile: type: object description: LLAP cluster profile. additionalProperties: true flinkProfile: $ref: '#/definitions/FlinkProfile' sparkProfile: $ref: '#/definitions/SparkProfile' stubProfile: type: object description: Stub cluster profile. additionalProperties: true scriptActionProfiles: $ref: '#/definitions/ScriptActionProfiles' description: Cluster profile. ManagedCassandraNodeState: type: string description: The state of the node in Cassandra ring. enum: - Normal - Leaving - Joining - Moving - Stopped x-ms-enum: name: NodeState modelAsString: true AuthorizationInfo: type: object properties: code: description: "Gets or sets one-time OAuth code to exchange for refresh and access tokens.\r\n\r\nOnly used during PUT operations. The secret is cleared during GET.\r\nIn general, RPaaS does not return any property marked as a secret." type: string example: '00000000000000000000.' x-ms-secret: true ApplicationInsightsComponent: properties: kind: type: string description: 'The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone.' etag: type: string description: Resource etag properties: x-ms-client-flatten: true description: Properties that define an Application Insights component resource. $ref: '#/definitions/ApplicationInsightsComponentProperties' allOf: - $ref: '#/definitions/ComponentsResource' required: - kind description: An Application Insights component definition. PrivateEndpointConnection_2: description: REST model used to encapsulate the user visible state of a PrivateEndpoint. type: object x-ms-azure-resource: true properties: id: description: Relative URL to get this Sites. type: string readOnly: true name: description: Gets the name of the resource. type: string readOnly: true type: description: Gets the resource type. type: string readOnly: true eTag: description: Gets the tag for optimistic concurrency control. type: string readOnly: true properties: $ref: '#/definitions/PrivateEndpointConnectionProperties_2' description: Gets the properties of the object. systemData: $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/systemData readOnly: true Logs: description: The logs. type: object properties: content: type: string description: The content of the log. AccountResourceList: description: The list of accounts. type: object properties: nextLink: type: string description: The link to the next page of items format: uri value: description: The list of recommendations. type: array items: $ref: '#/definitions/AccountResource' TrackedResourceModificationDetails: type: object description: The details of the policy triggered deployment that created or modified the tracked resource. properties: policyDetails: $ref: '#/definitions/PolicyDetails' description: The details of the policy that created or modified the tracked resource. readOnly: true deploymentId: description: The ID of the deployment that created or modified the tracked resource. type: string readOnly: true deploymentTime: description: Timestamp of the deployment that created or modified the tracked resource. type: string format: date-time readOnly: true UserAssignedManagedIdentities_2: type: object description: 'The list of user identities associated with the search service. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''.' additionalProperties: $ref: '#/definitions/UserAssignedManagedIdentity_2' VirtualMachinePatchParameters: type: object title: VirtualMachinePatchParameters represents the body of the request to patch the virtual machine. properties: properties: $ref: '#/definitions/VirtualMachinePatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string DeviceCapabilityRequest: description: Request body to get the device capabilities for given sku. type: object properties: skuName: description: Type of the device. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: SkuName modelAsExtensible: true values: - value: DataBox description: Data Box. - value: DataBoxDisk description: Data Box Disk. - value: DataBoxHeavy description: Data Box Heavy. - value: DataBoxCustomerDisk description: Data Box Customer Disk. VnetRoute: description: List of routes that control routing from VirtualHub into a virtual network connection. properties: staticRoutesConfig: $ref: '#/definitions/StaticRoutesConfig' description: Configuration for static routes on this HubVnetConnection. staticRoutes: type: array description: List of all Static Routes. items: $ref: '#/definitions/StaticRoute' bgpConnections: type: array readOnly: true description: The list of references to HubBgpConnection objects. items: $ref: ./network.json#/definitions/SubResource ProvisioningState_4: description: Defines the provisioning states. enum: - Succeeded - Updating - Creating - Failed type: string readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true FeatureStatus: type: object title: FeatureStatus contains information regarding a Kubernetes cluster feature. properties: detailedStatus: description: The status representing the state of this feature. type: string enum: - Running - Failed - Unknown x-ms-enum: modelAsString: true name: FeatureDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true name: description: The name of the feature. type: string readOnly: true version: description: The version of the feature. type: string readOnly: true SeedNode: type: object properties: ipAddress: description: IP address of this seed node. type: string VirtualWanProperties: properties: disableVpnEncryption: type: boolean description: Vpn encryption to be disabled or not. virtualHubs: type: array readOnly: true items: $ref: ./network.json#/definitions/SubResource description: List of VirtualHubs in the VirtualWAN. vpnSites: type: array readOnly: true items: $ref: ./network.json#/definitions/SubResource description: List of VpnSites in the VirtualWAN. allowBranchToBranchTraffic: type: boolean description: True if branch to branch traffic is allowed. allowVnetToVnetTraffic: type: boolean description: True if Vnet to Vnet traffic is allowed. office365LocalBreakoutCategory: description: The office local breakout category. $ref: '#/definitions/OfficeTrafficCategory' provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the virtual WAN resource. type: type: string description: The type of the VirtualWAN. description: Parameters for VirtualWAN. DnsResourceReference: type: object properties: dnsResources: type: array items: $ref: '#/definitions/SubResource' description: 'A list of dns Records ' targetResource: $ref: '#/definitions/SubResource' description: A reference to an azure resource from where the dns resource value is taken. description: Represents a single Azure resource and its referencing DNS records. InitContainerDefinition: description: The init container definition. type: object properties: name: description: The name for the init container. type: string properties: description: The properties for the init container. x-ms-client-flatten: true $ref: '#/definitions/InitContainerPropertiesDefinition' required: - name - properties ComponentPolicyEvaluationDetails: type: object description: Policy evaluation details. properties: evaluatedExpressions: description: Details of the evaluated expressions. type: array readOnly: true items: $ref: '#/definitions/ComponentExpressionEvaluationDetails' x-ms-identifiers: [] reason: description: Additional textual reason for the evaluation outcome. type: string ManagedIdentitySqlControlSettingsModel: type: object title: Managed Identity Sql Control Settings description: Sql Control Settings for workspace managed identity allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource properties: properties: title: Managed Identity Sql Control Settings description: Sql Control Settings for workspace managed identity properties: grantSqlControlToManagedIdentity: type: object description: Grant sql control to managed identity properties: desiredState: description: Desired state type: string enum: - Enabled - Disabled actualState: description: Actual state type: string enum: - Enabling - Enabled - Disabling - Disabled - Unknown readOnly: true x-ms-client-flatten: true EndpointAuthenticationsList: description: The list of service endpoints authentication details. type: array items: $ref: '#/definitions/EndpointAuthentication' x-ms-identifiers: [] Certificate: type: object properties: pem: description: PEM formatted public key. type: string VirtualMachineList: type: object title: VirtualMachineList represents a list of virtual machines. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of virtual machines. type: array items: $ref: '#/definitions/VirtualMachine' ScriptActionProfile: type: object description: The script action profile. required: - name - type - url - services properties: type: type: string description: Type of the script action. Supported type is bash scripts. name: type: string description: Script name. url: type: string description: Url of the script file. pattern: ^(https)|(http)|(abfss)|(abfs)|(wasbs)|(wasb)://.*$ parameters: type: string description: Additional parameters for the script action. It should be space-separated list of arguments required for script execution. services: items: type: string type: array description: List of services to apply the script action. timeoutInMinutes: type: integer format: int32 description: Timeout duration for the script action in minutes. shouldPersist: type: boolean default: true description: Specify if the script should persist on the cluster. NameUnavailabilityReason: description: The reason that the name is not available. type: string enum: - Invalid - AlreadyExists x-ms-enum: name: NameUnavailabilityReason modelAsString: true ClusterResourceProperties: type: object required: - clusterType - computeProfile - clusterProfile properties: provisioningState: description: Provisioning state of the resource. type: string enum: - Accepted - Succeeded - Canceled - Failed x-ms-enum: name: ProvisioningStatus modelAsString: true readOnly: true clusterType: type: string x-ms-mutability: - read - create description: The type of cluster. pattern: ^[a-zA-Z][a-zA-Z0-9]{0,31}$ deploymentId: type: string description: A unique id generated by the RP to identify the resource. example: 45cd32aead6e4a91b079a0cdbfac8c36 readOnly: true computeProfile: description: The compute profile. $ref: '#/definitions/ComputeProfile' clusterProfile: $ref: '#/definitions/ClusterProfile' status: type: string description: Business status of the resource. example: Running readOnly: true description: Cluster resource properties. RoutingConfiguration: description: Routing Configuration indicating the associated and propagated route tables for this connection. properties: associatedRouteTable: $ref: ./network.json#/definitions/SubResource description: The resource id RouteTable associated with this RoutingConfiguration. propagatedRouteTables: $ref: '#/definitions/PropagatedRouteTable' description: The list of RouteTables to advertise the routes to. vnetRoutes: $ref: '#/definitions/VnetRoute' description: List of routes that control routing from VirtualHub into a virtual network connection. inboundRouteMap: $ref: ./network.json#/definitions/SubResource description: The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. outboundRouteMap: $ref: ./network.json#/definitions/SubResource description: The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. CloudHsmCluster: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/CloudHsmClusterProperties' description: Properties of the Cloud HSM Cluster allOf: - $ref: '#/definitions/CloudHsmClusterResource' description: Resource information with extended details. type: object ProviderProperties: type: object description: Provider properties. properties: description: type: string description: A description about this provider. readOnly: true providerType: type: string description: Provider type. readOnly: true company: type: string description: Company name. readOnly: true defaultEndpoint: type: string description: Provider's default endpoint. readOnly: true aad: type: object description: Azure Active Directory info. properties: applicationId: type: string description: Provider's application id. readOnly: true tenantId: type: string description: Provider's tenant id. readOnly: true managedApplication: type: object description: Provider's Managed-Application info properties: publisherId: type: string description: Provider's publisher id. readOnly: true offerId: type: string description: Provider's offer id. readOnly: true targets: type: array description: The list of targets available from this provider. items: $ref: '#/definitions/TargetDescription' skus: type: array description: The list of skus available from this provider. items: $ref: '#/definitions/SkuDescription' quotaDimensions: type: array description: The list of quota dimensions from the provider. items: $ref: '#/definitions/QuotaDimension' pricingDimensions: type: array description: The list of pricing dimensions from the provider. items: $ref: '#/definitions/PricingDimension' ErrorResponse_2: description: Describes the format of Error response. type: object properties: code: description: Error code type: string message: description: Error message indicating why the operation failed. type: string SubscriptionDefinition: description: Subscription object properties. type: object properties: delegatedProviderSubscriptionId: description: Parent DelegatedProvider subscription identifier. type: string displayName: description: Subscription name. type: string id: description: Fully qualified identifier. type: string externalReferenceId: description: External reference identifier. type: string offerId: description: Identifier of the offer under the scope of a delegated provider. type: string owner: description: Subscription owner. type: string routingResourceManagerType: description: Routing resource manager type. $ref: '#/definitions/ResourceManagerType' state: description: Subscription state. $ref: '#/definitions/SubscriptionState_2' subscriptionId: description: Subscription identifier. type: string tenantId: description: Directory tenant identifier. type: string x-ms-azure-resource: true Cluster: type: object description: The cluster. properties: properties: x-ms-client-flatten: true description: Gets or sets the properties. Define cluster specific properties. $ref: '#/definitions/ClusterResourceProperties' systemData: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData description: SystemData of cluster. readOnly: true allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource RouteMapRule: properties: name: type: string description: The unique name for the rule. matchCriteria: type: array description: List of matching criterion which will be applied to traffic. items: $ref: '#/definitions/Criterion' x-ms-identifiers: [] actions: type: array description: List of actions which will be applied on a match. items: $ref: '#/definitions/Action' x-ms-identifiers: [] nextStepIfMatched: $ref: '#/definitions/NextStep' description: Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'. description: A RouteMap Rule. type: object StorageApplianceProperties: type: object title: StorageApplianceProperties represents the properties of the storage appliance. required: - rackId - storageApplianceSkuId - rackSlot - serialNumber - administratorCredentials properties: administratorCredentials: $ref: '#/definitions/AdministrativeCredentials' description: The credentials of the administrative interface on this storage appliance. x-ms-mutability: - read - create capacity: description: The total capacity of the storage appliance. type: integer format: int64 readOnly: true capacityUsed: description: The amount of storage consumed. type: integer format: int64 readOnly: true clusterId: description: The resource ID of the cluster this storage appliance is associated with. type: string format: arm-id readOnly: true detailedStatus: description: The detailed status of the storage appliance. type: string enum: - Error - Available - Provisioning x-ms-enum: modelAsString: true name: StorageApplianceDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true managementIpv4Address: description: The endpoint for the management interface of the storage appliance. type: string readOnly: true provisioningState: description: The provisioning state of the storage appliance. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted x-ms-enum: modelAsString: true name: StorageApplianceProvisioningState readOnly: true rackId: description: The resource ID of the rack where this storage appliance resides. type: string format: arm-id x-ms-mutability: - read - create rackSlot: description: The slot the storage appliance is in the rack based on the BOM configuration. type: integer format: int64 maximum: 256 minimum: 1 x-ms-mutability: - read - create remoteVendorManagementFeature: description: The indicator of whether the storage appliance supports remote vendor management. type: string enum: - Supported - Unsupported x-ms-enum: modelAsString: true name: RemoteVendorManagementFeature readOnly: true remoteVendorManagementStatus: description: The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. type: string enum: - Enabled - Disabled - Unsupported x-ms-enum: modelAsString: true name: RemoteVendorManagementStatus readOnly: true serialNumber: description: The serial number for the storage appliance. type: string storageApplianceSkuId: description: The SKU for the storage appliance. type: string x-ms-mutability: - read - create HealthMonitor: title: Information about the monitor’s current health status. properties: properties: description: Properties of the monitor's health status. x-ms-client-flatten: true $ref: '#/definitions/HealthMonitorProperties' allOf: - $ref: '#/definitions/Resource_10' IpRule: properties: value: type: string description: Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed. description: The IP restriction rule of the Azure Cognitive Search service. Update: description: Update details type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: location: type: string x-ms-mutability: - read - create description: The geo-location where the resource lives properties: description: Update properties type: object $ref: '#/definitions/UpdateProperties' x-ms-client-flatten: true ServiceStatus: type: object description: Describes the status of a service of a HDInsight on aks cluster. required: - kind - ready properties: kind: type: string description: Kind of the service. E.g. "Zookeeper". ready: type: string description: Indicates if the service is ready / healthy. Values can be "true", "false", "unknown" or anything else. message: type: string description: A message describing the error if any. StreamingPolicyFairPlayConfiguration: properties: customLicenseAcquisitionUrlTemplate: type: string description: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. allowPersistentLicense: type: boolean description: All license to be persistent or not type: object required: - allowPersistentLicense description: Class to specify configurations of FairPlay in Streaming Policy ProviderAvailability: type: string description: Provider availability. enum: - Available - Degraded - Unavailable x-ms-enum: name: ProviderAvailability modelAsString: true values: - name: Available value: Available description: Provider is available. - name: Degraded value: Degraded description: Provider is available with degraded experience. - name: Unavailable value: Unavailable description: Provider is unavailable. NoEncryption: properties: enabledProtocols: $ref: '#/definitions/EnabledProtocols' description: Representing supported protocols type: object description: Class for NoEncryption scheme OfferingsListResult: properties: value: type: array items: $ref: '#/definitions/ProviderDescription' description: Result of a list Providers operation. nextLink: type: string description: Link to the next set of results. Not empty if Value contains incomplete list of Providers. description: The response of a list Providers operation. ListP2SVpnGatewaysResult: description: Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/P2SVpnGateway' description: List of P2SVpnGateways. nextLink: type: string description: URL to get the next set of operation list results if there are any. AgentPoolPatchParameters: type: object title: AgentPoolPatchParameters represents the body of the request to patch the Kubernetes cluster agent pool. properties: properties: $ref: '#/definitions/AgentPoolPatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string WebConnectivityEndpoint: type: object description: Web connectivity endpoint details. required: - fqdn properties: fqdn: type: string description: Web connectivity endpoint. example: clusterName11223344.clusterPoolName55667788.eastus.hdinsightaks.net readOnly: true BareMetalMachineKeySetProperties: type: object title: BareMetalMachineKeySetProperties represents the properties of bare metal machine key set. required: - privilegeLevel - expiration - azureGroupId - jumpHostsAllowed - userList properties: azureGroupId: description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. type: string x-ms-mutability: - read - create detailedStatus: description: The more detailed status of the key set. type: string enum: - AllActive - SomeInvalid - AllInvalid - Validating x-ms-enum: modelAsString: true name: BareMetalMachineKeySetDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true expiration: description: The date and time after which the users in this key set will be removed from the bare metal machines. type: string format: date-time jumpHostsAllowed: description: The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. type: array items: type: string lastValidation: description: The last time this key set was validated. type: string format: date-time readOnly: true osGroupName: description: The name of the group that users will be assigned to on the operating system of the machines. type: string maxLength: 32 pattern: ^([A-Za-z]([A-Za-z0-9]*))$ x-ms-mutability: - read - create privilegeLevel: description: The access level allowed for the users in this key set. type: string enum: - Standard - Superuser x-ms-enum: modelAsString: true name: BareMetalMachineKeySetPrivilegeLevel x-ms-mutability: - read - create provisioningState: description: The provisioning state of the bare metal machine key set. type: string enum: - Succeeded - Failed - Canceled - Accepted - Provisioning x-ms-enum: modelAsString: true name: BareMetalMachineKeySetProvisioningState readOnly: true userList: description: The unique list of permitted users. type: array items: $ref: '#/definitions/KeySetUser' x-ms-identifiers: - azureUserName userListStatus: description: The status evaluation of each user. type: array items: $ref: '#/definitions/KeySetUserStatus' x-ms-identifiers: - azureUserName readOnly: true metricsSegmentInfo: description: A metric segment type: object properties: start: description: Start time of the metric segment (only when an interval was specified). type: string format: date_time end: description: Start time of the metric segment (only when an interval was specified). type: string format: date_time segments: description: Segmented metric data (if further segmented). type: array items: $ref: '#/definitions/metricsSegmentInfo' additionalProperties: true ListBackups: description: List of restorable backups for a Cassandra cluster. type: object properties: value: description: Container for array of backups. type: array readOnly: true items: $ref: '#/definitions/BackupResource' RemediationDeploymentsListResult: description: List of deployments for a remediation. properties: value: description: Array of deployments for the remediation. type: array items: $ref: '#/definitions/RemediationDeployment' readOnly: true nextLink: type: string description: The URL to get the next set of results. readOnly: true RegenerateKeyOutput: description: The response body for a RegenerateKey API. example: key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= properties: key: description: The new value of either the primary or secondary key. type: string Details: required: - code - message type: object properties: code: type: string message: type: string StreamingPolicyContentKeys: properties: defaultKey: $ref: '#/definitions/DefaultKey' description: Default content key for an encryption scheme keyToTrackMappings: type: array items: $ref: '#/definitions/StreamingPolicyContentKey' description: Representing tracks needs separate content key type: object description: Class to specify properties of all content keys in Streaming Policy L2NetworkProperties: type: object title: L2NetworkProperties represents properties of the L2 network. required: - l2IsolationDomainId properties: associatedResourceIds: description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. type: array items: type: string readOnly: true clusterId: description: The resource ID of the Network Cloud cluster this L2 network is associated with. type: string format: arm-id readOnly: true detailedStatus: description: The more detailed status of the L2 network. type: string enum: - Error - Available - Provisioning x-ms-enum: modelAsString: true name: L2NetworkDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true hybridAksClustersAssociatedIds: description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network. type: array items: type: string readOnly: true hybridAksPluginType: description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS. type: string default: SRIOV enum: - DPDK - SRIOV - OSDevice x-ms-enum: modelAsString: true name: HybridAksPluginType x-ms-mutability: - read - create interfaceName: description: The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. type: string maxLength: 12 pattern: ^[a-zA-Z0-9@._-]*$ x-ms-mutability: - read - create l2IsolationDomainId: description: The resource ID of the Network Fabric l2IsolationDomain. type: string format: arm-id x-ms-mutability: - read - create provisioningState: description: The provisioning state of the L2 network. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted x-ms-enum: modelAsString: true name: L2NetworkProvisioningState readOnly: true virtualMachinesAssociatedIds: description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network. type: array items: type: string readOnly: true GraphQueryError: properties: code: type: string description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. message: type: string description: Human-readable representation of the error. details: type: array items: $ref: '#/definitions/ErrorFieldContract' description: The list of invalid fields send in request, in case of validation error. description: Error message body that will indicate why the operation failed. EnableRequest: description: Describes a receiver that should be resubscribed. type: object properties: receiverName: type: string description: The name of the receiver to resubscribe. required: - receiverName ServiceLoadBalancerBgpPeer: type: object title: ServiceLoadBalancerBgpPeer represents the configuration of the BGP service load balancer for the Kubernetes cluster. required: - name - peerAddress - peerAsn properties: bfdEnabled: description: The indicator of BFD enablement for this BgpPeer. type: string default: 'False' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: BfdEnabled x-ms-mutability: - read - create bgpMultiHop: description: The indicator to enable multi-hop peering support. type: string default: 'False' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: BgpMultiHop x-ms-mutability: - read - create holdTime: description: The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H. type: string x-ms-mutability: - read - create keepAliveTime: description: The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H. type: string x-ms-mutability: - read - create myAsn: description: The autonomous system number used for the local end of the BGP session. type: integer format: int64 maximum: 4294967295 minimum: 0 x-ms-mutability: - read - create name: description: The name used to identify this BGP peer for association with a BGP advertisement. type: string pattern: ^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$ x-ms-mutability: - read - create password: description: The authentication password for routers enforcing TCP MD5 authenticated sessions. type: string maxLength: 80 pattern: ^[a-zA-Z0-9]{0,80}$ x-ms-mutability: - create x-ms-secret: true peerAddress: description: The IPv4 or IPv6 address used to connect this BGP session. type: string x-ms-mutability: - read - create peerAsn: description: The autonomous system number expected from the remote end of the BGP session. type: integer format: int64 maximum: 4294967295 minimum: 0 x-ms-mutability: - read - create peerPort: description: The port used to connect this BGP session. type: integer format: int64 default: 179 x-ms-mutability: - read - create ServiceEndpointPatchResource: description: ServiceEndpoint resource patch details. type: object properties: tags: description: Resource tags. $ref: '#/definitions/Tags' IotHubSettings: type: object description: Device Update account integration with IoT Hub settings. properties: resourceId: description: IoTHub resource ID type: string minLength: 108 maxLength: 244 required: - resourceId VpnSiteProperties: properties: virtualWan: $ref: ./network.json#/definitions/SubResource description: The VirtualWAN to which the vpnSite belongs. deviceProperties: description: The device properties. $ref: '#/definitions/DeviceProperties' ipAddress: type: string description: The ip-address for the vpn-site. siteKey: type: string description: The key for vpn-site that can be used for connections. addressSpace: $ref: ./virtualNetwork.json#/definitions/AddressSpace description: The AddressSpace that contains an array of IP address ranges. bgpProperties: $ref: ./virtualNetworkGateway.json#/definitions/BgpSettings description: The set of bgp properties. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the VPN site resource. isSecuritySite: type: boolean description: IsSecuritySite flag. vpnSiteLinks: type: array description: List of all vpn site links. items: $ref: '#/definitions/VpnSiteLink' o365Policy: readOnly: false description: Office365 Policy. $ref: '#/definitions/O365PolicyProperties' description: Parameters for VpnSite. AccessModeSettingsExclusion: type: object description: Properties that define the scope private link mode settings exclusion item. This setting applies to a specific private endpoint connection and overrides the default settings for that private endpoint connection. properties: privateEndpointConnectionName: description: The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings. type: string queryAccessMode: description: Specifies the access mode of queries through the specified private endpoint connection in the exclusion. $ref: '#/definitions/AccessMode' ingestionAccessMode: description: Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion. $ref: '#/definitions/AccessMode' Console: type: object title: Console represents the console of an on-premises Network Cloud virtual machine. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster manager associated with the cluster this virtual machine is created on. properties: $ref: '#/definitions/ConsoleProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true ClusterUpdateStrategy: type: object title: ClusterUpdateStrategy represents the strategy for updating the cluster. required: - strategyType - thresholdType - thresholdValue properties: maxUnavailable: description: 'The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size.' type: integer format: int64 minimum: 1 strategyType: description: The mode of operation for runtime protection. type: string enum: - Rack x-ms-enum: modelAsString: true name: ClusterUpdateStrategyType thresholdType: description: Selection of how the threshold should be evaluated. type: string enum: - CountSuccess - PercentSuccess x-ms-enum: modelAsString: true name: ValidationThresholdType thresholdValue: description: The numeric threshold value. type: integer format: int64 minimum: 0 waitTimeMinutes: description: The time to wait between the increments of update defined by the strategy. type: integer format: int64 default: 15 maximum: 60 minimum: 0 TrinoUserPlugin: type: object description: Trino user plugin. properties: enabled: type: boolean description: Denotes whether the plugin is active or not. name: type: string description: This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path. minLength: 1 path: type: string description: Fully qualified path to the folder containing the plugins. minLength: 1 pattern: ^(https)|(abfss)://.*$ ResourceNameAvailabilityRequest: description: Resource name availability request content. required: - name - type type: object properties: name: description: Resource name to verify. type: string type: description: Resource type used for verification. enum: - Site - Slot - HostingEnvironment - PublishingUser - Microsoft.Web/sites - Microsoft.Web/sites/slots - Microsoft.Web/hostingEnvironments - Microsoft.Web/publishingUsers type: string x-ms-enum: name: CheckNameResourceTypes modelAsString: true isFqdn: description: Is fully qualified domain name. type: boolean environmentId: description: Azure Resource Manager ID of the customer's selected Container Apps Environment on which to host the Function app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} type: string ContainerEvent: description: A container event. type: object properties: name: type: string description: The name of the container event. count: type: integer description: The count of the event. firstTimestamp: type: string description: Date/time of the first event. lastTimestamp: type: string description: Date/time of the last event. message: type: string description: The event message type: type: string description: The event type. ClusterVersionsListResult: type: object description: Represents a list of cluster versions. properties: value: type: array description: The list of cluster versions. items: $ref: '#/definitions/ClusterVersion' nextLink: type: string description: The link (url) to the next page of results. readOnly: true ClusterSecretArchive: type: object title: ClusterSecretArchive configures the key vault to archive the secrets of the cluster for later retrieval. required: - keyVaultId properties: keyVaultId: description: The resource ID of the key vault to archive the secrets of the cluster. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.KeyVault/vaults useKeyVault: description: The indicator if the specified key vault should be used to archive the secrets of the cluster. type: string default: 'False' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: ClusterSecretArchiveEnabled RouteMapProperties: properties: associatedInboundConnections: type: array description: List of connections which have this RoutMap associated for inbound traffic. items: type: string associatedOutboundConnections: type: array description: List of connections which have this RoutMap associated for outbound traffic. items: type: string rules: type: array description: List of RouteMap rules to be applied. items: $ref: '#/definitions/RouteMapRule' x-ms-identifiers: [] provisioningState: $ref: ./network.json#/definitions/ProvisioningState readOnly: true description: The provisioning state of the RouteMap resource. description: Properties of RouteMap resource type: object AutomationRunbookReceiver: description: The Azure Automation Runbook notification receiver. type: object properties: automationAccountId: type: string description: The Azure automation account Id which holds this runbook and authenticate to Azure resource. runbookName: type: string description: The name for this runbook. webhookResourceId: type: string description: The resource id for webhook linked to this runbook. isGlobalRunbook: type: boolean description: Indicates whether this instance is global runbook. name: type: string description: Indicates name of the webhook. serviceUri: type: string description: The URI where webhooks should be sent. useCommonAlertSchema: type: boolean default: false description: Indicates whether to use common alert schema. required: - automationAccountId - runbookName - webhookResourceId - isGlobalRunbook O365BreakOutCategoryPolicies: properties: allow: type: boolean readOnly: false description: Flag to control allow category. optimize: type: boolean readOnly: false description: Flag to control optimize category. default: type: boolean readOnly: false description: Flag to control default category. description: Office365 breakout categories. HealthBotProperties: type: object title: HealthBotProperties description: The properties of a Azure Health Bot. The Health Bot Service is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs. properties: provisioningState: type: string description: The provisioning state of the Azure Health Bot resource. readOnly: true botManagementPortalLink: type: string description: The link. readOnly: true keyVaultProperties: $ref: '#/definitions/KeyVaultProperties' description: KeyVault properties for the resource encryption. GpuResource: description: The GPU resource. type: object required: - count - sku properties: count: description: The count of the GPU resource. type: integer format: int32 sku: type: string description: The SKU of the GPU resource. enum: - K80 - P100 - V100 x-ms-enum: name: GpuSku modelAsString: true GuestDiagnosticSettings: description: Virtual machine diagnostic settings properties: osType: type: string enum: - Windows - Linux description: Operating system type for the configuration dataSources: type: array items: $ref: '#/definitions/DataSource' description: the array of data source object which are configured to collect and send data proxySetting: type: string queryParam: description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) type: string StorageAppliancePatchParameters: type: object title: StorageAppliancePatchParameters represents the body of the request to patch storage appliance properties. properties: properties: $ref: '#/definitions/StorageAppliancePatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string SkuDescription: type: object description: Information about a specific sku. properties: id: type: string description: Unique sku id. name: type: string description: Display name of this sku. version: type: string description: Display name of this sku. description: type: string description: Description about this sku. restrictedAccessUri: type: string description: Uri to subscribe to the restricted access sku. autoAdd: type: boolean description: Flag to indicate whether the sku should be automatically added during workspace creation. targets: type: array description: The list of targets available for this sku. items: type: string quotaDimensions: type: array description: The list of quota dimensions for this sku. items: $ref: '#/definitions/QuotaDimension' pricingDetails: type: array description: The list of pricing details for the sku. items: $ref: '#/definitions/PricingDetail' ErrorAdditionalInfo_2: properties: type: readOnly: true type: string description: The additional info type. info: readOnly: true type: object description: The additional info. description: The resource management error additional info. KubernetesClusterPatchParameters: type: object title: KubernetesClusterPatchParameters represents the body of the request to patch the Hybrid AKS cluster. properties: properties: $ref: '#/definitions/KubernetesClusterPatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string VpnServerConfiguration: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnServerConfigurationProperties' description: Properties of the P2SVpnServer configuration. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. allOf: - $ref: ./network.json#/definitions/Resource description: VpnServerConfiguration Resource. pipeline: type: object x-ms-azure-resource: true properties: properties: $ref: '#/definitions/pipelineProperties' required: - location allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource description: The pipeline resource definition. VpnLinkProviderProperties: properties: linkProviderName: type: string description: Name of the link provider. linkSpeedInMbps: type: integer format: int32 description: Link speed. description: List of properties of a link provider. DomainUserCredentials: description: Get Domain user name and password from key vault type: object properties: keyVaultUrl: description: Key vault url to get the domain username and password type: string userNameSecret: description: 'Domain user name secret ' type: string passwordSecret: description: 'Domain Password secret ' type: string SecretStore: type: object description: An option to store secret value in secure place properties: keyVaultId: x-nullable: true type: string description: The key vault id to store secret keyVaultSecretName: x-nullable: true type: string description: The key vault secret name to store secret, only valid when storing one secret UserAssignedIdentityMap: type: object description: 'The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''. ' additionalProperties: $ref: '#/definitions/UserAssignedIdentity' AssessedNetworkAdapter: type: object description: A network adapter assessed for an assessment. properties: macAddress: type: string description: MAC Address of the network adapter. readOnly: true ipAddresses: type: array description: List of IP Addresses on the network adapter. readOnly: true items: type: string description: IP Address of the network adapter. readOnly: true monthlyBandwidthCosts: type: number format: double description: Monthly cost estimate for network bandwidth used by this network adapter. readOnly: true megabytesPerSecondTransmitted: type: number format: double description: Adapter throughput for outgoing traffic in MegaBytes per second. readOnly: true megabytesPerSecondReceived: type: number format: double description: Adapter throughput for incoming traffic in MegaBytes per second. readOnly: true netGigabytesTransmittedPerMonth: type: number format: double description: Gigabytes transmitted through this adapter each month. suitability: type: string enum: - Unknown - NotSuitable - Suitable - ConditionallySuitable description: Whether this adapter is suitable for Azure. readOnly: true x-ms-enum: name: CloudSuitability modelAsString: true suitabilityExplanation: type: string enum: - Unknown - NotApplicable - InternalErrorOccured description: If network adapter is suitable, this explains the reasons and mitigation steps. readOnly: true x-ms-enum: name: AzureNetworkAdapterSuitabilityExplanation modelAsString: true Instance: description: Device Update instance details. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource properties: properties: description: Device Update instance properties. x-ms-client-flatten: true type: object properties: provisioningState: description: Provisioning state. type: string enum: - Succeeded - Deleted - Failed - Canceled - Accepted - Creating readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true accountName: description: Parent Device Update Account name which Instance belongs to. type: string readOnly: true iotHubs: description: List of IoT Hubs associated with the account. type: array items: $ref: '#/definitions/IotHubSettings' enableDiagnostics: description: Enables or Disables the diagnostic logs collection type: boolean diagnosticStorageProperties: $ref: '#/definitions/DiagnosticStorageProperties' required: - properties VpnLinkBgpSettings: properties: asn: type: integer format: int64 description: The BGP speaker's ASN. bgpPeeringAddress: type: string description: The BGP peering address and BGP identifier of this BGP speaker. description: BGP settings details for a link. StreamingPath: properties: streamingProtocol: type: string enum: - Hls - Dash - SmoothStreaming - Download x-ms-enum: name: StreamingPolicyStreamingProtocol values: - value: Hls description: HLS protocol - value: Dash description: DASH protocol - value: SmoothStreaming description: SmoothStreaming protocol - value: Download description: Download protocol modelAsExtensible: true description: Streaming protocol encryptionScheme: type: string enum: - NoEncryption - EnvelopeEncryption - CommonEncryptionCenc - CommonEncryptionCbcs x-ms-enum: name: EncryptionScheme values: - value: NoEncryption description: NoEncryption scheme - value: EnvelopeEncryption description: EnvelopeEncryption scheme - value: CommonEncryptionCenc description: CommonEncryptionCenc scheme - value: CommonEncryptionCbcs description: CommonEncryptionCbcs scheme modelAsExtensible: true description: Encryption scheme paths: type: array items: type: string description: Streaming paths for each protocol and encryptionScheme pair type: object required: - streamingProtocol - encryptionScheme description: Class of paths for streaming CloudError_6: x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody_5' description: An error response from Kusto. Azure.Core.Foundations.InnerError: type: object description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. properties: code: type: string description: One of a server-defined set of error codes. innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: Inner error. IotHub: properties: id: type: string description: The IoT Hub resource identifier. identity: $ref: '#/definitions/ResourceIdentity' description: The IoT Hub identity. status: type: string description: The current status of the Iot Hub mapping. readOnly: true type: object required: - id - identity description: The IoT Hub details. connectionProperties: type: object properties: pipeline: type: string description: Pipeline to use to transfer data direction: description: Direction of data movement enum: - Send - Receive type: string x-ms-enum: name: direction modelAsString: true justification: type: string description: Justification for the connection request status: description: Status of the connection enum: - InReview - Approved - Rejected - Accepted type: string x-ms-enum: name: status modelAsString: true readOnly: true statusReason: type: string description: Reason for status readOnly: true linkStatus: enum: - Linked - Unlinked type: string x-ms-enum: name: linkStatus modelAsString: true description: Link status of the current connection readOnly: true linkedConnectionId: type: string description: Resource ID of the linked connection readOnly: true flowTypes: $ref: '#/definitions/flowTypes' description: The flow types being requested for this connection requirementId: description: Requirement ID of the connection type: string remoteSubscriptionId: description: Subscription ID to link cloud subscriptions together type: string approver: description: Approver of this connection request type: string readOnly: true pin: description: PIN to link requests together type: string dateSubmitted: type: string format: date-time description: The timestamp that this connection request was submitted at readOnly: true primaryContact: type: string description: The primary contact for this connection request secondaryContacts: type: array description: The secondary contacts for this connection request items: type: string provisioningState: description: Provisioning state of the connection enum: - Failed - Succeeded - Canceled - Accepted type: string x-ms-enum: name: provisioningState modelAsString: true readOnly: true policies: type: array description: The policies for this connection items: type: string schemas: description: The schemas for this connection $ref: '#/definitions/schemas' required: - pipeline description: Properties of connection ScriptActionProfiles: type: array description: The script action profile list. items: $ref: '#/definitions/ScriptActionProfile' x-ms-identifiers: [] JobType: type: string description: The type of the job. enum: - Unknown - QuantumComputing - Optimization x-ms-enum: name: JobType modelAsString: true values: - name: Unknown value: Unknown description: Unknown job type. - name: QuantumComputing value: QuantumComputing description: Quantum Computing job type. - name: Optimization value: Optimization description: Optimization job type. HardwareInventoryNetworkInterface: type: object title: HardwareInventoryNetworkInterface represents the network interface details as part of a hardware inventory. properties: linkStatus: description: The current status of the link. type: string readOnly: true macAddress: description: The MAC address associated with this interface. type: string readOnly: true name: description: The name of the interface. type: string readOnly: true networkInterfaceId: description: The resource ID of the network interface for the port on the switch that this machine's interface is connected to. type: string readOnly: true ApiError_3: description: The error returned from a failed Media Services REST API call. example: error: code: BadRequest message: Name availability check is not supported for type Microsoft.Media/mediaservices. properties: code: description: Error code. type: string message: description: Error message. type: string ThreeOrFourPartVersionPattern: type: string description: Version with 3/4 part. example: 1.0.4 pattern: ^(0|[1-9][0-9]{0,18})\.(0|[1-9][0-9]{0,18})\.(0|[1-9][0-9]{0,18})(?:\.(0|[1-9][0-9]{0,18}))?$ ManagedCassandraProvisioningState: description: The status of the resource at the time the operation was called. type: string enum: - Creating - Updating - Deleting - Succeeded - Failed - Canceled x-ms-enum: name: ManagedCassandraProvisioningState modelAsString: true PrivateEndpointConnectionDataModel: type: object description: The Data Model for a Private Endpoint Connection associated with a Private Link Scope properties: id: description: The ARM Resource Id of the Private Endpoint. type: string readOnly: true name: description: The Name of the Private Endpoint. type: string readOnly: true type: type: string readOnly: true description: Azure resource type properties: $ref: '#/definitions/PrivateEndpointConnectionProperties_3' description: The Private Endpoint Connection properties. ConnectedClusterIdentity: type: object required: - type properties: principalId: readOnly: true type: string description: The principal id of connected cluster identity. This property will only be provided for a system assigned identity. tenantId: readOnly: true type: string description: The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity. type: type: string description: The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster. default: SystemAssigned enum: - None - SystemAssigned x-ms-enum: name: ResourceIdentityType modelAsString: false description: Identity for the connected cluster. ApiError_2: required: - error type: object properties: error: $ref: '#/definitions/ErrorDetail_3' CloudError_2: type: object x-ms-external: true properties: error: description: The body of the error response. $ref: '#/definitions/CloudErrorBody_2' description: An error response from the Batch service. RemediationProperties: properties: policyAssignmentId: type: string description: The resource ID of the policy assignment that should be remediated. policyDefinitionReferenceId: type: string description: The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition. provisioningState: type: string description: The status of the remediation. readOnly: true createdOn: type: string format: date-time description: The time at which the remediation was created. readOnly: true lastUpdatedOn: type: string format: date-time description: The time at which the remediation was last updated. readOnly: true filters: $ref: '#/definitions/RemediationFilters' description: The filters that will be applied to determine which resources to remediate. deploymentStatus: $ref: '#/definitions/RemediationDeploymentSummary' description: The deployment status summary for all deployments created by the remediation. description: The remediation properties. TransportAvailabilityDetails: description: Transport options availability details for given region. type: object properties: shipmentType: description: Transport Shipment Type supported for given region. enum: - CustomerManaged - MicrosoftManaged type: string readOnly: true x-ms-enum: name: TransportShipmentTypes modelAsExtensible: true values: - value: CustomerManaged description: Shipment Logistics is handled by the customer. - value: MicrosoftManaged description: Shipment Logistics is handled by Microsoft. PricingDetail: type: object description: Detailed pricing information for an sku. properties: id: type: string description: Unique id for this pricing information. value: type: string description: The unit cost of this sku. ResourceType: description: Type of MediaService resource. enum: - mediaservices type: string x-ms-enum: name: ResourceType modelAsString: false GraphQueryUpdateParameters: properties: tags: type: object additionalProperties: type: string description: Resource tags etag: type: string description: This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict. properties: x-ms-client-flatten: true description: Metadata describing a graph query for an Azure resource. $ref: '#/definitions/GraphQueryPropertiesUpdateParameters' description: The parameters that can be provided when updating workbook properties properties. ProjectSummary: type: object description: Project summary. properties: instanceType: type: string description: Instance type. readOnly: true refreshSummaryState: enum: - Started - InProgress - Completed - Failed type: string x-ms-enum: name: refreshSummaryState modelAsString: true description: Refresh summary state. lastSummaryRefreshedTime: format: date-time type: string description: Last summary refresh time. extendedSummary: type: object description: Extended summary. additionalProperties: type: string CheckNameAvailabilityResult_2: properties: nameAvailable: readOnly: true type: boolean description: Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used. reason: readOnly: true type: string enum: - Invalid - AlreadyExists x-ms-enum: name: NameAvailabilityReason modelAsString: false values: - value: Invalid description: The requested name is invalid. - value: AlreadyExists description: The requested name is already in use. description: Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false. message: readOnly: true type: string description: Gets an error message explaining the Reason value in more detail. description: The CheckNameAvailability operation response. TagDetails: properties: id: readOnly: true type: string description: The tag name ID. tagName: type: string description: The tag name. count: $ref: '#/definitions/TagCount' description: The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. values: type: array items: $ref: '#/definitions/TagValue' description: The list of tag values. x-ms-azure-resource: true description: Tag details. ClusterManagerPatchParameters: type: object title: ClusterManagerPatchParameters represents the body of the request to patch the cluster properties. properties: tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string Subscription: description: List of supported operations. type: object properties: displayName: description: Subscription name. type: string id: description: Fully qualified identifier. type: string offerId: description: Identifier of the offer under the scope of a delegated provider. type: string state: description: Subscription state. $ref: '#/definitions/SubscriptionState' subscriptionId: description: Subscription identifier. type: string tenantId: description: Directory tenant identifier. type: string ModelingResourceList: description: The list of Modeling resources. type: object properties: nextLink: description: The link used to get the next page of Modeling resources list. type: string value: description: The list of Modeling resources. type: array items: $ref: '#/definitions/ModelingResource' StorageApplianceSkuSlot: type: object title: StorageApplianceSkuSlot represents the single SKU and rack slot associated with the storage appliance. properties: properties: $ref: '#/definitions/StorageApplianceSkuProperties' description: The list of the resource properties. x-ms-client-flatten: true rackSlot: description: The position in the rack for the storage appliance. type: integer format: int64 readOnly: true applicationsParam: description: Application IDs to include in cross-application queries. type: array items: type: string StreamingPolicyCollection: properties: value: type: array items: $ref: '#/definitions/StreamingPolicy' description: A collection of StreamingPolicy items. '@odata.nextLink': type: string description: A link to the next page of the collection (when the collection contains too many results to return in one response). type: object description: A collection of StreamingPolicy items. SubscriptionState: description: Subscription notification state. type: string enum: - NotDefined - Enabled - Warned - PastDue - Disabled - Deleted x-ms-enum: name: SubscriptionState modelAsString: true AzureDevOpsProjectListResponse: type: object properties: value: description: Gets or sets list of resources. type: array items: $ref: '#/definitions/AzureDevOpsProject' x-ms-identifiers: [] nextLink: description: Gets or sets next link to scroll over the results. type: string VideoContentUrls: properties: downloadUrl: type: string description: Video file download URL. This URL can be used in conjunction with the video content authorization token to download the video MP4 file. The resulting MP4 file can be played on any standard media player. It is available when the video type is 'file' and video file is available for consumption. archiveBaseUrl: type: string description: "Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any compatible DASH or HLS players by appending the following to the base URL:\r\n\r\n - HLSv4: /manifest(format=m3u8-aapl).m3u8\r\n - HLS CMAF: /manifest(format=m3u8-cmaf)\r\n - DASH CMAF: /manifest(format=mpd-time-cmaf)\r\n\r\n Moreover, an ongoing video recording can be played in \"live mode\" with latencies which are approximately double of the chosen video segment length. It is available when the video type is 'archive' and video archiving is enabled." rtspTunnelUrl: type: string description: Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a live, low-latency feed is available from the source. previewImageUrls: $ref: '#/definitions/VideoPreviewImageUrls' description: Video preview image URLs. These URLs can be used in conjunction with the video content authorization token to download the most recent still image from the video archive in different resolutions. They are available when the video type is 'archive' and preview images are enabled. type: object description: Set of URLs to the video content. DaprMetadata: description: The dapr component metadata. type: object properties: name: description: Metadata property name. type: string value: description: Metadata property value. type: string secretRef: description: The secret name where dapr could get value type: string description: description: The description of the metadata, returned from configuration api type: string required: description: The value indicating whether the metadata is required or not type: string enum: - 'true' - 'false' x-ms-enum: name: DaprMetadataRequired modelAsString: true ResourceLimits: description: The resource limits. type: object properties: memoryInGB: description: The memory limit in GB of this container instance. type: number format: double cpu: description: The CPU limit of this container instance. type: number format: double gpu: description: The GPU limit of this container instance. $ref: '#/definitions/GpuResource' BareMetalMachineCordonParameters: type: object title: BareMetalMachineCordonParameters represents the body of the request to evacuate workloads from node on a bare metal machine. properties: evacuate: description: The indicator of whether to evacuate the node workload when the bare metal machine is cordoned. type: string default: 'False' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: BareMetalMachineEvacuate SubResource: type: object properties: id: type: string description: Resource Id. description: A reference to a another resource VolumeList: type: object title: VolumeList represents a list of volumes. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of volumes. type: array items: $ref: '#/definitions/Volume_2' P2SVpnGatewayProperties: properties: virtualHub: $ref: ./network.json#/definitions/SubResource description: The VirtualHub to which the gateway belongs. p2SConnectionConfigurations: type: array description: List of all p2s connection configurations of the gateway. items: $ref: '#/definitions/P2SConnectionConfiguration' provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the P2S VPN gateway resource. vpnGatewayScaleUnit: type: integer format: int32 description: The scale unit for this p2s vpn gateway. vpnServerConfiguration: $ref: ./network.json#/definitions/SubResource description: The VpnServerConfiguration to which the p2sVpnGateway is attached to. vpnClientConnectionHealth: readOnly: true $ref: '#/definitions/VpnClientConnectionHealth' description: All P2S VPN clients' connection health status. customDnsServers: type: array description: List of all customer specified DNS servers IP addresses. items: type: string isRoutingPreferenceInternet: type: boolean description: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. description: Parameters for P2SVpnGateway. ContainerState: description: The container instance state. type: object readOnly: true properties: state: type: string readOnly: true description: The state of the container instance. startTime: type: string readOnly: true format: date-time description: The date-time when the container instance state started. exitCode: type: integer format: int32 readOnly: true description: The container instance exit codes correspond to those from the `docker run` command. finishTime: type: string readOnly: true format: date-time description: The date-time when the container instance state finished. detailStatus: type: string readOnly: true description: The human-readable status of the container instance state. RegistrationStatus: type: string description: Registration status enum: - Registered - Not Registered x-ms-enum: name: RegistrationStatus modelAsString: true AzureDevOpsConnectorStatsListResponse: type: object properties: value: description: Gets or sets list of resources. type: array items: $ref: '#/definitions/AzureDevOpsConnectorStats' x-ms-identifiers: [] nextLink: description: Gets or sets next link to scroll over the results. type: string EnvironmentVariable_2: description: Describes an environment variable for the container. type: object properties: name: description: The name of the environment variable. type: string value: description: The value of the environment variable. type: string AzureDevOpsOrgMetadata: description: Org onboarding info. type: object properties: name: description: Gets or sets name of the AzureDevOps Org. type: string autoDiscovery: $ref: '#/definitions/AutoDiscovery' projects: type: array items: $ref: '#/definitions/AzureDevOpsProjectMetadata' x-ms-identifiers: [] GeoRegionCollection: description: Collection of geographical regions. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/GeoRegion' nextLink: description: Link to next page of resources. type: string readOnly: true SkuEnumerationForNewResourceResult: description: An object that represents enumerating SKUs for new resources. type: object properties: value: type: array items: $ref: '#/definitions/ResourceSku' description: The collection of available SKUs for new resources. ClusterResizeData: type: object description: The parameters for resizing a cluster. properties: properties: x-ms-client-flatten: true description: Sets the properties. Define cluster resize specific properties. $ref: '#/definitions/ClusterResizeProperties' allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource queryTimespan: description: Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression. type: string flowType: enum: - Unknown - Complex - DevSecOps - Messaging - Mission - MicrosoftInternal - BasicFiles - Data type: string x-ms-enum: name: flowType modelAsString: true description: Flow type for the specified resource PrivateEndpointConnectionProxy: description: Private endpoint connection proxy details. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource - $ref: '#/definitions/PrivateEndpointConnectionProxyProperties' properties: properties: description: Private endpoint connection proxy object property bag. type: object x-ms-client-flatten: true properties: provisioningState: $ref: '#/definitions/PrivateEndpointConnectionProxyProvisioningState' description: The provisioning state of the private endpoint connection proxy resource. AttestationEvidence: properties: description: type: string description: The description for this piece of evidence. sourceUri: type: string description: The URI location of the evidence. description: A piece of evidence supporting the compliance state set in the attestation. VpnGatewayNatRule: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnGatewayNatRuleProperties' description: Properties of the VpnGateway NAT rule. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. type: readOnly: true type: string description: Resource type. allOf: - $ref: ./network.json#/definitions/SubResource description: VpnGatewayNatRule Resource. CloudHsmProperties: type: object description: The Cloud HSM Properties properties: fqdn: type: string description: FQDN of the Cloud HSM state: type: string description: The Cloud HSM State stateMessage: type: string description: The Cloud HSM State message GuestDiagnosticSettingsResource: type: object allOf: - $ref: '#/definitions/Resource_5' required: - properties properties: properties: x-ms-client-flatten: true $ref: '#/definitions/GuestDiagnosticSettings' description: The diagnostic settings to be applied to azure resources. description: Virtual machine guest diagnostics settings resource. ClusterProperties: type: object title: ClusterProperties represents the properties of a cluster. required: - networkFabricId - clusterType - clusterVersion - aggregatorOrSingleRackDefinition properties: aggregatorOrSingleRackDefinition: $ref: '#/definitions/RackDefinition' description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. analyticsWorkspaceId: description: The resource ID of the Log Analytics Workspace that will be used for storing relevant logs. type: string availableUpgradeVersions: description: The list of cluster runtime version upgrades available for this cluster. type: array items: $ref: '#/definitions/ClusterAvailableUpgradeVersion' x-ms-identifiers: - targetClusterVersion readOnly: true clusterCapacity: $ref: '#/definitions/ClusterCapacity' description: The capacity supported by this cluster. readOnly: true clusterConnectionStatus: description: The latest heartbeat status between the cluster manager and the cluster. type: string enum: - Connected - Disconnected - Timeout - Undefined x-ms-enum: modelAsString: true name: ClusterConnectionStatus readOnly: true clusterExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator. readOnly: true clusterLocation: description: The customer-provided location information to identify where the cluster resides. type: string maxLength: 256 clusterManagerConnectionStatus: description: The latest connectivity status between cluster manager and the cluster. type: string enum: - Connected - Unreachable x-ms-enum: modelAsString: true name: ClusterManagerConnectionStatus readOnly: true clusterManagerId: description: The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.NetworkCloud/clusterManagers readOnly: true clusterServicePrincipal: $ref: '#/definitions/ServicePrincipalInformation' description: The service principal to be used by the cluster during Arc Appliance installation. clusterType: description: The type of rack configuration for the cluster. type: string enum: - SingleRack - MultiRack x-ms-enum: modelAsString: true name: ClusterType x-ms-mutability: - read - create clusterVersion: description: The current runtime version of the cluster. type: string x-ms-mutability: - read - create computeDeploymentThreshold: $ref: '#/definitions/ValidationThreshold' description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. computeRackDefinitions: description: 'The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.' type: array items: $ref: '#/definitions/RackDefinition' x-ms-identifiers: - networkRackId detailedStatus: description: The current detailed status of the cluster. type: string enum: - PendingDeployment - Deploying - Running - Updating - Degraded - Deleting - Disconnected - Failed x-ms-enum: modelAsString: true name: ClusterDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the detailed status. type: string readOnly: true hybridAksExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters). readOnly: true managedResourceGroupConfiguration: $ref: '#/definitions/ManagedResourceGroupConfiguration' description: The configuration of the managed resource group associated with the resource. manualActionCount: description: The count of Manual Action Taken (MAT) events that have not been validated. type: integer format: int64 readOnly: true networkFabricId: description: The resource ID of the Network Fabric associated with the cluster. type: string format: arm-id x-ms-mutability: - read - create provisioningState: description: The provisioning state of the cluster. type: string enum: - Succeeded - Failed - Canceled - Accepted - Validating - Updating x-ms-enum: modelAsString: true name: ClusterProvisioningState readOnly: true runtimeProtectionConfiguration: $ref: '#/definitions/RuntimeProtectionConfiguration' description: The settings for cluster runtime protection. secretArchive: $ref: '#/definitions/ClusterSecretArchive' description: The configuration for use of a key vault to store secrets for later retrieval by the operator. supportExpiryDate: description: The support end date of the runtime version of the cluster. type: string readOnly: true updateStrategy: $ref: '#/definitions/ClusterUpdateStrategy' description: The strategy for updating the cluster. workloadResourceIds: description: The list of workload resource IDs that are hosted within this cluster. type: array items: type: string readOnly: true VolumePatchParameters: type: object title: VolumePatchParameters represents the body of the request to patch the volume resource. properties: tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string ServiceConfigListResult: type: object description: Cluster instance service configs api response. properties: value: type: array description: Cluster instance service config array. items: $ref: '#/definitions/ServiceConfigResult' x-ms-identifiers: [] nextLink: type: string description: The link (url) to the next page of results. readOnly: true DiagnosticsRef: description: Reference to sinks in DiagnosticsDescription. type: object properties: enabled: description: Status of whether or not sinks are enabled. type: boolean sinkRefs: description: List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription. type: array items: type: string VpnConnection: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnConnectionProperties' description: Properties of the VPN connection. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. allOf: - $ref: ./network.json#/definitions/SubResource description: VpnConnection Resource. ClusterPoolListResult: type: object properties: value: type: array items: $ref: '#/definitions/ClusterPool' description: The list of cluster pools. nextLink: type: string description: The link (url) to the next page of results. readOnly: true description: The list cluster pools operation response. HealthStatus: description: Health Status. type: string enum: - Unknown - Unhealthy - Healthy x-ms-enum: name: HealthStatus modelAsString: true values: - description: The health status is unknown. name: Unknown value: Unknown - description: The health status is unhealthy, indicating something is wrong or a sub-health status is Unhealthy or Unknown. name: Unhealthy value: Unhealthy - description: The health status is healthy, indicating nothing is wrong. name: Healthy value: Healthy ActionGroupPatchBody: description: An action group object for the body of patch operations. type: object properties: tags: type: object additionalProperties: type: string description: Resource tags properties: x-ms-client-flatten: true $ref: '#/definitions/ActionGroupPatch' description: The action group settings for an update operation. resourceBody: type: object properties: id: type: string description: ID of the resource. statusReason: type: string description: Reason for resource operation. required: - id description: The resource to reference. EnergyServiceProperties: type: object properties: dnsName: type: string readOnly: true provisioningState: enum: - Unknown - Succeeded - Failed - Canceled - Creating - Deleting - Updating type: string readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true authAppId: type: string readOnly: false dataPartitionNames: type: array items: $ref: '#/definitions/DataPartitionNames' x-ms-identifiers: [] SearchServiceUpdate: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/SearchServiceProperties' description: Properties of the search service. sku: $ref: '#/definitions/Sku_4' description: The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. externalDocs: url: https://azure.microsoft.com/documentation/articles/search-sku-tier/ location: type: string description: The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource. externalDocs: url: https://aka.ms/search-rp-info x-ms-mutability: - create - read tags: type: object additionalProperties: type: string description: Tags to help categorize the resource in the Azure portal. identity: $ref: '#/definitions/Identity_4' description: Details about the search service identity. A null value indicates that the search service has no identity assigned. allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/Resource description: The parameters used to update an Azure Cognitive Search service. schemasListResult: type: object properties: value: description: Schemas array. $ref: '#/definitions/schemas' description: The schemas list result. StaticRoutesConfig: description: Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. type: object properties: propagateStaticRoutes: description: Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. type: boolean readOnly: true vnetLocalRouteOverrideCriteria: description: Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. $ref: '#/definitions/VnetLocalRouteOverrideCriteria' TrackPropertyCondition: properties: property: type: string enum: - Unknown - FourCC x-ms-enum: name: TrackPropertyType values: - value: Unknown description: Unknown track property - value: FourCC description: Track FourCC modelAsExtensible: true description: Track property type operation: type: string enum: - Unknown - Equal x-ms-enum: name: TrackPropertyCompareOperation values: - value: Unknown description: Unknown track property compare operation - value: Equal description: Equal operation modelAsExtensible: true description: Track property condition operation value: type: string description: Track property value type: object required: - property - operation description: Class to specify one track property condition L2NetworkAttachmentConfiguration: type: object title: L2NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 2 network. required: - networkId properties: networkId: description: The resource ID of the network that is being configured for attachment. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.NetworkCloud/l2Networks x-ms-mutability: - read - create pluginType: description: The indicator of how this network will be utilized by the Kubernetes cluster. type: string default: SRIOV enum: - DPDK - SRIOV - OSDevice - MACVLAN - IPVLAN x-ms-enum: modelAsString: true name: KubernetesPluginType x-ms-mutability: - read - create TargetBranchConfiguration: description: Branch onboarding info. type: object properties: names: description: "Gets or sets branches that should have annotations.\r\n\r\nFor Ignite, we will be supporting a single default branch configuration in the UX." type: array items: type: string x-ms-identifiers: [] EndpointDependency: type: object title: EndpointDependency represents the definition of an endpoint, including the domain and details. required: - domainName properties: domainName: description: The domain name of the dependency. type: string port: description: The port of this endpoint. type: integer format: int64 maximum: 65535 minimum: 1 ResourceRequirements: description: The resource requirements. type: object required: - requests properties: requests: description: The resource requests of this container instance. $ref: '#/definitions/ResourceRequests' limits: description: The resource limits of this container instance. $ref: '#/definitions/ResourceLimits' HealthBotKeysResponse: type: object description: Health Bot Keys Response. properties: secrets: type: array x-ms-identifiers: [] items: $ref: '#/definitions/HealthBotKey' description: Array of Azure Health Bot Secrets. minLength: 3 maxLength: 3 RoutingIntent: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/RoutingIntentProperties' description: Properties of the RoutingIntent resource. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. type: readOnly: true type: string description: Resource type. allOf: - $ref: ./network.json#/definitions/SubResource description: The routing intent child resource of a Virtual hub. type: object CanonicalSupportPlanResponseEnvelope: type: object description: The status of the Canonical support plan. required: - properties properties: id: readOnly: true type: string description: The id of the ARM resource, e.g. "/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}". name: readOnly: true type: string description: The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". type: readOnly: true type: string description: Microsoft.Addons/supportProvider properties: type: object $ref: '#/definitions/CanonicalSupportPlanProperties' description: Describes Canonical support plan type and status. x-ms-client-flatten: true x-ms-azure-resource: true CheckRestrictionsResourceDetails: description: The information about the resource that will be evaluated. properties: resourceContent: description: The resource content. This should include whatever properties are already known and can be a partial set of all resource properties. type: object apiVersion: description: The api-version of the resource content. type: string scope: description: The scope where the resource is being created. For example, if the resource is a child resource this would be the parent resource's resource ID. type: string required: - resourceContent SummaryResults: description: Non-compliance summary on a particular summary level. properties: queryResultsUri: description: HTTP POST URI for queryResults action on Microsoft.PolicyInsights to retrieve raw results for the non-compliance summary. type: string nonCompliantResources: description: Number of non-compliant resources. type: integer format: int32 minimum: 0 nonCompliantPolicies: description: Number of non-compliant policies. type: integer format: int32 minimum: 0 GitHubRepoListResponse: type: object properties: value: description: Gets or sets list of resources. type: array items: $ref: '#/definitions/GitHubRepo' x-ms-identifiers: [] nextLink: description: Gets or sets next link to scroll over the results. type: string StreamingPolicyWidevineConfiguration: properties: customLicenseAcquisitionUrlTemplate: type: string description: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. type: object description: Class to specify configurations of Widevine in Streaming Policy NotificationRequestBody: description: The request body which contain contact detail metadata type: object properties: alertType: type: string maxLength: 30 description: 'The value of the supported alert type. Supported alert type values are: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget' emailReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/EmailReceiver' description: The list of email receivers that are part of this action group. smsReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/SmsReceiver' description: The list of SMS receivers that are part of this action group. webhookReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/WebhookReceiver' description: The list of webhook receivers that are part of this action group. itsmReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/ItsmReceiver' description: The list of ITSM receivers that are part of this action group. azureAppPushReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/AzureAppPushReceiver' description: The list of AzureAppPush receivers that are part of this action group. automationRunbookReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/AutomationRunbookReceiver' description: The list of AutomationRunbook receivers that are part of this action group. voiceReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/VoiceReceiver' description: The list of voice receivers that are part of this action group. logicAppReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/LogicAppReceiver' description: The list of logic app receivers that are part of this action group. azureFunctionReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/AzureFunctionReceiver' description: The list of azure function receivers that are part of this action group. armRoleReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/ArmRoleReceiver' description: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported. eventHubReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/EventHubReceiver' description: The list of event hub receivers that are part of this action group. required: - alertType ErrorAdditionalInfo_3: properties: type: readOnly: true type: string description: The additional info type. info: readOnly: true type: object description: The additional info. description: The resource management error additional info. connectionsListResult: type: object properties: value: type: array items: $ref: '#/definitions/connection' description: Connections array. x-ms-identifiers: - id nextLink: description: Link to next results type: string description: The connections list result. TransportPreferences: description: Preferences related to the shipment logistics of the sku required: - preferredShipmentType type: object properties: preferredShipmentType: description: Indicates Shipment Logistics type that the customer preferred. enum: - CustomerManaged - MicrosoftManaged type: string x-ms-enum: name: TransportShipmentTypes modelAsExtensible: true values: - value: CustomerManaged description: Shipment Logistics is handled by the customer. - value: MicrosoftManaged description: Shipment Logistics is handled by Microsoft. isUpdated: description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. type: boolean readOnly: true ConnectedClusterPatch: type: object properties: tags: type: object additionalProperties: type: string description: Resource tags. properties: x-ms-client-flatten: true $ref: '#/definitions/ConnectedClusterPatchProperties' description: Describes the connected cluster resource properties that can be updated during PATCH operation. description: Object containing updates for patch operations. VideoAnalyzerPrivateEndpointConnectionOperationStatus: properties: name: type: string description: Operation identifier. id: type: string description: Operation resource ID. startTime: type: string description: Operation start time. endTime: type: string description: Operation end time. status: type: string description: Operation status. error: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail x-nullable: true type: object required: - name description: Status of private endpoint connection operation. Machine: type: object x-ms-azure-resource: true description: A machine in a migration project. properties: id: type: string description: Path reference to this machine. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/machines/{machineName} readOnly: true name: type: string description: Name of the machine. It is a GUID which is unique identifier of machine in private data center. For user-readable name, we have a displayName property on this machine. readOnly: true eTag: type: string description: For optimistic concurrency control. type: type: string description: Type of the object = [Microsoft.Migrate/projects/machines]. readOnly: true properties: description: Properties of the machine. x-ms-client-flatten: true $ref: '#/definitions/MachineProperties' ScalingRule: type: object description: The scaling rule. required: - actionType - comparisonRule - evaluationCount - scalingMetric properties: actionType: type: string description: The action type. enum: - scaleup - scaledown x-ms-enum: name: ScaleActionType modelAsString: true evaluationCount: type: integer format: int32 description: This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. scalingMetric: type: string description: 'Metrics name for individual workloads. For example: cpu' comparisonRule: $ref: '#/definitions/ComparisonRule' VirtualMachinePlacementHint: type: object title: VirtualMachinePlacementHint represents a single scheduling hint of the virtual machine. required: - hintType - schedulingExecution - resourceId - scope properties: hintType: description: The specification of whether this hint supports affinity or anti-affinity with the referenced resources. type: string enum: - Affinity - AntiAffinity x-ms-enum: modelAsString: true name: VirtualMachinePlacementHintType x-ms-mutability: - read - create resourceId: description: The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. type: string format: arm-id x-ms-mutability: - read - create schedulingExecution: description: The indicator of whether the hint is a hard or soft requirement during scheduling. type: string enum: - Hard - Soft x-ms-enum: modelAsString: true name: VirtualMachineSchedulingExecution x-ms-mutability: - read - create scope: description: The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. type: string enum: - Rack - Machine x-ms-enum: modelAsString: true name: VirtualMachinePlacementHintPodAffinityScope x-ms-mutability: - read - create DomainControllerProperties: description: The properties of domain controller to which SCOM and SQL servers join for AuthN/AuthZ. type: object properties: domainName: description: Fully qualified domain name type: string dnsServer: description: 'IP address of DNS server ' type: string ouPath: description: Organizational Unit path in which the SCOM servers will be present type: string default: '' CachedImagesListResult: description: The response containing cached images. type: object properties: value: type: array items: $ref: '#/definitions/cachedImages' x-ms-identifiers: - image description: The list of cached images. nextLink: type: string description: The URI to fetch the next page of cached images. StaticRoute: description: List of all Static Routes. properties: name: type: string description: The name of the StaticRoute that is unique within a VnetRoute. addressPrefixes: type: array description: List of all address prefixes. items: type: string nextHopIpAddress: type: string description: The ip address of the next hop. ListDataCenters: description: List of managed Cassandra data centers and their properties. type: object properties: value: description: Container for array of data centers. type: array readOnly: true items: $ref: '#/definitions/DataCenterResource' pipelinesPatch: type: object properties: properties: type: object properties: connections: type: array items: $ref: '#/definitions/pipelineConnection' description: Connections associated with pipeline x-ms-identifiers: - id flowTypes: $ref: '#/definitions/flowTypes' description: The flow types allowed for this pipeline description: Properties of pipelines patch body. tags: type: object additionalProperties: type: string description: Resource tags description: The pipelines resource patch definition. EmailReceiver: description: An email receiver. type: object properties: name: type: string description: The name of the email receiver. Names must be unique across all receivers within an action group. emailAddress: type: string description: The email address of this receiver. useCommonAlertSchema: type: boolean default: false description: Indicates whether to use common alert schema. status: readOnly: true $ref: '#/definitions/ReceiverStatus' description: The receiver status of the e-mail. required: - name - emailAddress ValidateAddress: description: The requirements to validate customer address where the device needs to be shipped. required: - shippingAddress - deviceType - validationType type: object allOf: - $ref: '#/definitions/ValidationInputRequest' properties: shippingAddress: $ref: '#/definitions/ShippingAddress' description: Shipping address of the customer. deviceType: description: Device type to be used for the job. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: SkuName modelAsExtensible: true values: - value: DataBox description: Data Box. - value: DataBoxDisk description: Data Box Disk. - value: DataBoxHeavy description: Data Box Heavy. - value: DataBoxCustomerDisk description: Data Box Customer Disk. transportPreferences: $ref: '#/definitions/TransportPreferences' description: Preferences related to the shipment logistics of the sku. x-ms-discriminator-value: ValidateAddress BareMetalMachineList: type: object title: BareMetalMachineList represents a list of bare metal machines. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of bare metal machines. type: array items: $ref: '#/definitions/BareMetalMachine' 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. pendingConnectionsListResult: type: object properties: value: type: array items: $ref: '#/definitions/pendingConnection' description: Connections array. x-ms-identifiers: - id nextLink: description: Link to next results type: string description: The connections list result. CheckRestrictionsResult: description: The result of a check policy restrictions evaluation on a resource. properties: fieldRestrictions: description: The restrictions that will be placed on various fields in the resource by policy. type: array items: $ref: '#/definitions/FieldRestrictions' readOnly: true contentEvaluationResult: description: Evaluation results for the provided partial resource content. properties: policyEvaluations: description: Policy evaluation results against the given resource content. This will indicate if the partial content that was provided will be denied as-is. type: array items: $ref: '#/definitions/PolicyEvaluationResult' readOnly: true CapabilitiesListResult: description: The response containing list of capabilities. type: object properties: value: type: array items: $ref: '#/definitions/Capabilities' x-ms-identifiers: - resourceType - location description: The list of capabilities. nextLink: type: string description: The URI to fetch the next page of capabilities. HealthState: type: string enum: - Unknown - Success - Failure - Warning - Error - InProgress x-ms-enum: name: HealthState modelAsString: true CloudHsmClusterResource: properties: sku: $ref: '#/definitions/CloudHsmClusterSku' description: SKU details identity: $ref: ../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource description: Cloud HSM Cluster Resource type: object x-ms-azure-resource: true TargetStatus: type: object description: Target status. properties: id: type: string description: Target id. readOnly: true currentAvailability: $ref: '#/definitions/TargetAvailability' description: Current target availability. readOnly: true averageQueueTime: type: integer format: int64 description: Average queue time in seconds. readOnly: true statusPage: type: string description: A page with detailed status of the provider. readOnly: true required: - id - currentAvailability - averageQueueTime BgpServiceLoadBalancerConfiguration: type: object title: BgpServiceLoadBalancerConfiguration represents the configuration of a BGP service load balancer. properties: bgpAdvertisements: description: The association of IP address pools to the communities and peers, allowing for announcement of IPs. type: array items: $ref: '#/definitions/BgpAdvertisement' x-ms-identifiers: [] x-ms-mutability: - read - create bgpPeers: description: The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined. type: array items: $ref: '#/definitions/ServiceLoadBalancerBgpPeer' x-ms-identifiers: [] x-ms-mutability: - read - create fabricPeeringEnabled: description: The indicator to specify if the load balancer peers with the network fabric. type: string default: 'True' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: FabricPeeringEnabled x-ms-mutability: - read - create ipAddressPools: description: The list of pools of IP addresses that can be allocated to Load Balancer services. type: array items: $ref: '#/definitions/IpAddressPool' x-ms-identifiers: [] x-ms-mutability: - read - create UsageListResult: description: The response containing the usage data type: object properties: value: readOnly: true type: array description: The usage data. items: $ref: '#/definitions/Usage' x-ms-identifiers: - name CloudErrorBody_4: type: object x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. 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 x-ms-identifiers: [] items: $ref: '#/definitions/CloudErrorBody_4' description: A list of additional details about the error. description: An error response from the service. ClusterPoolVersion: type: object description: Available cluster pool version. properties: properties: x-ms-client-flatten: true description: Cluster pool version properties. $ref: '#/definitions/ClusterPoolVersionProperties' allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource CloudErrorBody_3: x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. 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_3' x-ms-identifiers: - message - target description: A list of additional details about the error. description: An error response from the Container Instance service. ServiceResourceDescription: description: This type describes a service resource. allOf: - $ref: '#/definitions/ManagedProxyResource' properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ServiceResourceProperties' description: This type describes properties of a service resource. required: - properties TestNotificationDetailsResponse: description: The details of the test notification results. type: object properties: context: type: object $ref: '#/definitions/Context' state: type: string description: The overall state completedTime: type: string description: The completed time createdTime: type: string description: The created time actionDetails: x-ms-identifiers: [] type: array items: $ref: '#/definitions/ActionDetail' description: The list of action detail required: - state CustomHostnameSites: description: A hostname and its assigned sites type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: CustomHostnameSites resource specific properties type: object properties: customHostname: type: string region: type: string siteResourceIds: type: array items: $ref: ./CommonDefinitions.json#/definitions/Identifier x-ms-client-flatten: true PolicyState: type: object description: Policy state record. properties: '@odata.id': description: OData entity ID; always set to null since policy state records do not have an entity ID. type: string '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string timestamp: description: Timestamp for the policy state record. type: string format: date-time resourceId: description: Resource ID. type: string policyAssignmentId: description: Policy assignment ID. type: string policyDefinitionId: description: Policy definition ID. type: string effectiveParameters: description: Effective parameters for the policy assignment. type: string isCompliant: description: Flag which states whether the resource is compliant against the policy assignment it was evaluated against. type: boolean subscriptionId: description: Subscription ID. type: string resourceType: description: Resource type. type: string resourceLocation: description: Resource location. type: string resourceGroup: description: Resource group name. type: string resourceTags: description: List of resource tags. type: string policyAssignmentName: description: Policy assignment name. type: string policyAssignmentOwner: description: Policy assignment owner. type: string policyAssignmentParameters: description: Policy assignment parameters. type: string policyAssignmentScope: description: Policy assignment scope. type: string policyDefinitionName: description: Policy definition name. type: string policyDefinitionAction: description: Policy definition action, i.e. effect. type: string policyDefinitionCategory: description: Policy definition category. type: string policySetDefinitionId: description: Policy set definition ID, if the policy assignment is for a policy set. type: string policySetDefinitionName: description: Policy set definition name, if the policy assignment is for a policy set. type: string policySetDefinitionOwner: description: Policy set definition owner, if the policy assignment is for a policy set. type: string policySetDefinitionCategory: description: Policy set definition category, if the policy assignment is for a policy set. type: string policySetDefinitionParameters: description: Policy set definition parameters, if the policy assignment is for a policy set. type: string managementGroupIds: description: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under. type: string policyDefinitionReferenceId: description: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set. type: string complianceState: description: Compliance state of the resource. type: string policyEvaluationDetails: description: Policy evaluation details. type: object $ref: '#/definitions/PolicyEvaluationDetails' additionalProperties: description: The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated FlinkHiveCatalogOption: type: object description: Hive Catalog Option for Flink cluster. required: - metastoreDbConnectionURL - metastoreDbConnectionUserName - metastoreDbConnectionPasswordSecret properties: metastoreDbConnectionPasswordSecret: description: Secret reference name from secretsProfile.secrets containing password for database connection. type: string metastoreDbConnectionURL: description: Connection string for hive metastore database. type: string metastoreDbConnectionUserName: description: User name for database connection. type: string ErrorDetails: title: Error details type: object properties: code: description: Error code identifying the specific error. type: string message: description: A human-readable error message. type: string VideoContentToken: properties: expirationDate: type: string format: date-time description: The content token expiration date in ISO8601 format (eg. 2021-01-01T00:00:00Z). readOnly: true x-nullable: false token: type: string description: The content token value to be added to the video content URL as the value for the "token" query string parameter. The token is specific to a single video. readOnly: true type: object description: '"Video content token grants access to the video content URLs."' ClusterLogAnalyticsApplicationLogs: type: object description: Collection of logs to be enabled or disabled for log analytics. properties: stdOutEnabled: type: boolean description: True if stdout is enabled, otherwise false. stdErrorEnabled: type: boolean description: True if stderror is enabled, otherwise false. DataCenterResource: description: A managed Cassandra data center. type: object allOf: - $ref: cosmos-db.json#/definitions/ARMProxyResource properties: properties: description: Properties of a managed Cassandra data center. type: object properties: provisioningState: $ref: '#/definitions/ManagedCassandraProvisioningState' dataCenterLocation: type: string x-ms-mutability: - create - read description: The region this data center should be created in. delegatedSubnetId: type: string x-ms-mutability: - create - read description: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. nodeCount: type: integer format: int32 description: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. seedNodes: readOnly: true type: array description: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. items: $ref: '#/definitions/SeedNode' base64EncodedCassandraYamlFragment: type: string description: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. managedDiskCustomerKeyUri: type: string description: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. backupStorageCustomerKeyUri: type: string description: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. sku: type: string description: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 diskSku: type: string description: Disk SKU used for data centers. Default value is P30. diskCapacity: type: integer format: int32 description: Number of disks attached to each node. Default is 4. availabilityZone: type: boolean description: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. authenticationMethodLdapProperties: $ref: '#/definitions/AuthenticationMethodLdapProperties' deallocated: type: boolean description: Whether the data center has been deallocated. provisionError: $ref: '#/definitions/CassandraError' description: Error related to resource provisioning. privateEndpointIpAddress: type: string description: Ip of the VPN Endpoint for this data center. errorInfo: title: The code and message for an error. type: object properties: code: description: A machine readable error code. type: string message: description: A human readable error message. type: string details: description: error details. type: array items: $ref: '#/definitions/errorDetail' innererror: description: Inner error details if they exist. $ref: '#/definitions/errorInfo' additionalProperties: type: object required: - code - message ClusterServiceConfigsProfile: type: object description: Cluster service configs. required: - serviceName - configs properties: serviceName: type: string description: Name of the service the configurations should apply to. configs: type: array description: List of service configs. items: $ref: '#/definitions/ClusterServiceConfig' x-ms-identifiers: [] AdministratorConfiguration: type: object title: AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters. properties: adminUsername: description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. type: string x-ms-mutability: - read - create sshPublicKeys: description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. type: array items: $ref: '#/definitions/SshPublicKey' TagCount: properties: type: type: string description: Type of count. value: type: integer description: Value of count. description: Tag count. SearchServiceListResult: properties: value: readOnly: true type: array items: $ref: '#/definitions/SearchService' description: The list of Search services. nextLink: readOnly: true type: string description: Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size. description: Response containing a list of Azure Cognitive Search services. x-ms-external: true ConsolePatchParameters: type: object title: ConsolePatchParameters represents the body of the request to patch the virtual machine console. properties: properties: $ref: '#/definitions/ConsolePatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string ClusterList: type: object title: ClusterList represents a list of clusters. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of clusters. type: array items: $ref: '#/definitions/Cluster_2' NextStep: type: string description: Supported next step behaviors after a rule is applied to a matched route enum: - Unknown - Continue - Terminate x-ms-enum: name: NextStep modelAsString: true StreamingLocatorProperties: properties: assetName: type: string description: Asset Name created: type: string format: date-time description: Creation time of Streaming Locator readOnly: true x-nullable: false startTime: type: string format: date-time description: StartTime of Streaming Locator endTime: type: string format: date-time description: EndTime of Streaming Locator streamingLocatorId: type: string format: uuid description: StreamingLocatorId of Streaming Locator streamingPolicyName: type: string description: 'Streaming policy name used by this streaming locator. Either specify the name of streaming policy you created or use one of the predefined streaming polices. The predefined streaming policies available are: ''Predefined_DownloadOnly'', ''Predefined_ClearStreamingOnly'', ''Predefined_DownloadAndClearStreaming'', ''Predefined_ClearKey'', ''Predefined_SecureStreaming'' and ''Predefined_SecureStreamingWithFairPlay''' defaultContentKeyPolicyName: type: string description: Default ContentKeyPolicy used by this Streaming Locator contentKeys: type: array items: $ref: '#/definitions/StreamingLocatorContentKey' description: ContentKeys used by this Streaming Locator alternativeMediaId: type: string description: An Alternative Media Identifier associated with the StreamingLocator. This identifier can be used to distinguish different StreamingLocators for the same Asset for authorization purposes in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. type: object required: - assetName - streamingPolicyName description: Class to specify properties of Streaming Locator ClusterPool: type: object description: Cluster pool. properties: properties: x-ms-client-flatten: true description: Gets or sets the properties. Define cluster pool specific properties. $ref: '#/definitions/ClusterPoolResourceProperties' systemData: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData description: SystemData of cluster pool. readOnly: true allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource FieldRestrictions: description: The restrictions that will be placed on a field in the resource by policy. properties: field: description: The name of the field. This can be a top-level property like 'name' or 'type' or an Azure Policy field alias. type: string readOnly: true restrictions: description: The restrictions placed on that field by policy. type: array items: $ref: '#/definitions/FieldRestriction' UserAssignedManagedIdentity: properties: clientId: type: string format: uuid description: The client ID. readOnly: true x-nullable: true principalId: type: string format: uuid description: The principal ID. readOnly: true x-nullable: true type: object description: The details of the user assigned managed identity used by the Video Analyzer resource. AuthorizationProfile: type: object description: Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. properties: userIds: type: array description: AAD user Ids authorized for data plane access. items: type: string groupIds: type: array description: AAD group Ids authorized for data plane access. items: type: string SparkUserPlugins: type: object description: Spark user plugins spec properties: plugins: type: array description: Spark user plugins. items: $ref: '#/definitions/SparkUserPlugin' x-ms-identifiers: [] flow: type: object x-ms-azure-resource: true properties: properties: $ref: '#/definitions/flowProperties' plan: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/Plan identity: $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity description: The managed identity of the flow resource, if configured. required: - location allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource description: The flow resource definition. AvailableUpgrade: type: object title: AvailableUpgrade represents an upgrade available for a Kubernetes cluster. properties: availabilityLifecycle: description: The version lifecycle indicator. type: string enum: - Preview - GenerallyAvailable x-ms-enum: modelAsString: true name: AvailabilityLifecycle readOnly: true version: description: The version available for upgrading. type: string readOnly: true UsageEvent: type: object description: Usage event details. properties: dimensionId: type: string description: The dimension id. dimensionName: type: string description: The dimension name. measureUnit: type: string description: The unit of measure. amountBilled: type: number format: float description: The amount billed. amountConsumed: type: number format: float description: The amount consumed. unitPrice: type: number format: float description: The unit price. required: - dimensionId - dimensionName - measureUnit - amountBilled - amountConsumed - unitPrice NetworkInterface: type: object title: NetworkInterface represents properties of the network interface. properties: address: description: The partial address of Peripheral Component Interconnect (PCI). type: string readOnly: true deviceConnectionType: description: The connection type of the device. type: string enum: - PCI x-ms-enum: modelAsString: true name: DeviceConnectionType readOnly: true model: description: The model name of the device. type: string readOnly: true physicalSlot: description: The physical slot for this device. type: integer format: int64 readOnly: true portCount: description: The number of ports on the device. type: integer format: int64 readOnly: true portSpeed: description: The maximum amount of data in GB that the line card transmits through a port at any given second. type: integer format: int64 readOnly: true vendor: description: The vendor name of the device. type: string readOnly: true SasUriResponse: type: object description: SAS URI operation response. properties: sasUri: type: string description: A URL with a SAS token to upload a blob for execution in the given workspace. readOnly: true required: - sasUri RackDefinition: type: object title: RackDefinition represents details regarding the rack. required: - networkRackId - rackSkuId - rackSerialNumber properties: availabilityZone: description: The zone name used for this rack when created. Availability zones are used for workload placement. type: string pattern: ^[a-zA-Z0-9]{1,10}$ bareMetalMachineConfigurationData: description: The unordered list of bare metal machine configuration. type: array items: $ref: '#/definitions/BareMetalMachineConfigurationData' x-ms-identifiers: [] networkRackId: description: The resource ID of the network rack that matches this rack definition. type: string format: arm-id rackLocation: description: The free-form description of the rack's location. type: string maxLength: 256 rackSerialNumber: description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. type: string maxLength: 64 minLength: 1 rackSkuId: description: The resource ID of the sku for the rack being added. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.NetworkCloud/rackSkus storageApplianceConfigurationData: description: The list of storage appliance configuration data for this rack. type: array items: $ref: '#/definitions/StorageApplianceConfigurationData' x-ms-identifiers: [] metadataTableGroup: title: A group of tables. description: The table grouping can be either an Application Insights schema or a Log Analytics solution. type: object properties: id: description: The ID of the table group type: string name: description: The name of the table group type: string source: description: The source of the table group, can be either AI or OMS for Log Analytics workspaces type: string displayName: description: The display name of the table group type: string description: description: The description of the table group type: string tables: description: The list of tables contained in the table group type: array items: type: string required: - id - name ClusterPoolNetworkProfile: type: object description: Cluster pool networking configuration. required: - subnetId properties: subnetId: type: string description: Cluster pool subnet resource id. format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.Network/virtualNetworks/subnets AccessPolicyEntityCollection: properties: value: type: array items: $ref: '#/definitions/AccessPolicyEntity' description: A collection of AccessPolicyEntity items. '@nextLink': type: string description: A link to the next page of the collection (when the collection contains too many results to return in one response). type: object description: A collection of AccessPolicyEntity items. LinkerProperties: description: The properties of the Linker. type: object properties: targetService: $ref: '#/definitions/TargetServiceBase' description: The target service properties authInfo: description: The authentication type. $ref: '#/definitions/AuthInfoBase' clientType: description: The application client type $ref: '#/definitions/ClientType' provisioningState: readOnly: true type: string description: 'The provisioning state. ' vNetSolution: x-nullable: true description: The VNet solution. $ref: '#/definitions/VNetSolution' secretStore: x-nullable: true description: An option to store secret value in secure place $ref: '#/definitions/SecretStore' scope: x-nullable: true type: string description: connection scope in source service. publicNetworkSolution: x-nullable: true description: The network solution. $ref: '#/definitions/PublicNetworkSolution' configurationInfo: x-nullable: true description: The connection information consumed by applications, including secrets, connection strings. $ref: '#/definitions/ConfigurationInfo' DataPartitionNames: type: object description: The list of Energy services resource's Data Partition Names. properties: name: type: string BmcKeySetPatchParameters: type: object title: BmcKeySetPatchParameters represents the body of the request to patch the baseboard management controller key set. properties: properties: $ref: '#/definitions/BmcKeySetPatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string ServiceConfigListResultValueEntity: type: object description: Default config details. properties: value: type: string description: Config value. description: type: string description: Config description. required: - value HardwareInventory: type: object title: HardwareInventory represents the hardware configuration of this machine as exposed to the customer, including information acquired from the model/sku information and from the ironic inspector. properties: additionalHostInformation: description: Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration. type: string readOnly: true interfaces: description: The list of network interfaces and associated details for the bare metal machine. type: array items: $ref: '#/definitions/HardwareInventoryNetworkInterface' x-ms-identifiers: - name readOnly: true nics: description: Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine. type: array items: $ref: '#/definitions/Nic' x-ms-identifiers: - name readOnly: true ApiError: properties: error: $ref: '#/definitions/ODataError' description: The error properties. type: object description: The API error. NodePoolAdministratorConfigurationPatch: type: object title: NodePoolAdministratorConfigurationPatch represents the patching capabilities for the administrator configuration. properties: sshPublicKeys: description: SshPublicKey represents the public key used to authenticate with a resource through SSH. type: array items: $ref: '#/definitions/SshPublicKey' x-ms-identifiers: - keyData NetworkVirtualApplianceConnectionList: type: object properties: value: type: array items: $ref: '#/definitions/NetworkVirtualApplianceConnection' description: The list of NetworkVirtualAppliance connections. nextLink: type: string description: URL to get the next set of results. description: NetworkVirtualApplianceConnection list. Sku: type: object description: The resource model definition representing SKU properties: name: type: string description: The name of the Azure Health Bot SKU enum: - F0 - S1 - C0 x-ms-enum: name: SkuName modelAsString: false required: - name GitHubConnectorProperties: description: Properties of the ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors. type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState_3' code: description: "Gets or sets one-time OAuth code to exchange for refresh and access tokens.\r\n\r\nOnly used during PUT operations. The secret is cleared during GET.\r\nIn general, RPaaS does not return any property marked as a secret." type: string example: '00000000000000000000.' x-ms-secret: true ComputeProfile: type: object description: The compute profile. required: - nodes properties: nodes: type: array description: The nodes definitions. items: $ref: '#/definitions/NodeProfile' x-ms-identifiers: [] VnetParameters: description: The required set of inputs to validate a VNET type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: VnetParameters resource specific properties type: object properties: vnetResourceGroup: description: The Resource Group of the VNET to be validated type: string vnetName: description: The name of the VNET to be validated type: string vnetSubnetName: description: The subnet name to be validated type: string subnetResourceId: description: The ARM Resource ID of the subnet to validate type: string x-ms-client-flatten: true UpdateProperties: description: Details of a singular Update in HCI Cluster type: object properties: provisioningState: description: Provisioning state of the Updates proxy resource. type: string enum: - Succeeded - Failed - Canceled - Accepted - Provisioning x-ms-enum: name: ProvisioningState modelAsString: true readOnly: true installedDate: description: Date that the update was installed. type: string format: date-time description: description: Description of the update. type: string state: description: State of the update as it relates to this stamp. type: string enum: - HasPrerequisite - Obsolete - Ready - NotApplicableBecauseAnotherUpdateIsInProgress - Preparing - Installing - Installed - PreparationFailed - InstallationFailed - Invalid - Recalled - Downloading - DownloadFailed - HealthChecking - HealthCheckFailed - ReadyToInstall - ScanInProgress - ScanFailed - AdditionalContentRequired x-ms-enum: name: state modelAsString: true prerequisites: description: If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. type: array items: $ref: '#/definitions/UpdatePrerequisite' x-ms-identifiers: - packageName componentVersions: description: 'An array of component versions for a Solution Bundle update, and an empty array otherwise. ' type: array items: $ref: '#/definitions/PackageVersionInfo' x-ms-client-flatten: true x-ms-identifiers: - version rebootRequired: type: object $ref: '#/definitions/RebootRequirement' x-ms-client-flatten: true healthState: description: Overall health state for update-specific health checks. type: object $ref: '#/definitions/HealthState' x-ms-client-flatten: true healthCheckResult: description: An array of PrecheckResult objects. type: array items: $ref: '#/definitions/PrecheckResult' x-ms-client-flatten: true healthCheckDate: description: Last time the package-specific checks were run. type: string format: date-time packagePath: description: Path where the update package is available. type: string packageSizeInMb: description: Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content. type: number displayName: description: Display name of the Update type: string version: description: Version of the update. type: string publisher: description: Publisher of the update package. type: string releaseLink: description: Link to release notes for the update. type: string availabilityType: description: Indicates the way the update content can be downloaded. type: string enum: - Local - Online - Notify x-ms-enum: name: availabilityType modelAsString: true packageType: description: Customer-visible type of the update. type: string additionalProperties: description: Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type. type: string updateStateProperties: description: Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property. type: object $ref: '#/definitions/UpdateStateProperties' x-ms-client-flatten: true ErrorDefinition: description: Error definition. properties: code: description: Service specific error code which serves as the substatus for the HTTP error code. type: string readOnly: true message: description: Description of the error. type: string readOnly: true target: description: The target of the error. type: string readOnly: true details: description: Internal error details. type: array items: $ref: '#/definitions/ErrorDefinition' x-ms-identifiers: [] readOnly: true additionalInfo: description: Additional scenario specific error details. type: array items: $ref: '#/definitions/TypedErrorInfo' x-ms-identifiers: [] readOnly: true UserAssignedIdentity: properties: principalId: readOnly: true type: string description: The principal ID of user assigned identity. clientId: readOnly: true type: string description: The client ID of user assigned identity. type: object description: The details of the user assigned managed identity used by the Video Analyzer resource. ClusterResizeProperties: type: object description: The properties for resizing a cluster. required: - targetWorkerNodeCount properties: targetWorkerNodeCount: type: integer format: int32 description: Target node count of worker node. EnergyResourceUpdate: description: The resource model definition used for updating a tracked ARM resource. type: object properties: tags: description: Resource tags. type: object additionalProperties: type: string StageStatus: description: Stage status. type: object properties: stage: description: The stage name. type: string status: description: The status of the stage. type: string time: description: The time of the status. type: string format: date-time DatacenterAddressRequest: description: Request body to get the datacenter address. required: - storageLocation - skuName type: object properties: storageLocation: description: 'Storage location. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01' type: string skuName: description: Sku Name for which the data center address requested. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: SkuName modelAsExtensible: true values: - value: DataBox description: Data Box. - value: DataBoxDisk description: Data Box Disk. - value: DataBoxHeavy description: Data Box Heavy. - value: DataBoxCustomerDisk description: Data Box Customer Disk. VirtualHub: required: - location properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VirtualHubProperties' description: Properties of the virtual hub. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. kind: readOnly: true type: string description: Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server. allOf: - $ref: ./network.json#/definitions/Resource description: VirtualHub Resource. AssessedDisk: type: object description: A disk assessed for an assessment. properties: name: type: string description: Name of the assessed disk. readOnly: true gigabytesProvisioned: type: number format: double description: Gigabytes of storage provisioned for this disk. readOnly: true gigabytesConsumed: type: number format: double description: Gigabytes of storage consumed by this disk. readOnly: true megabytesPerSecondOfRead: type: number format: double description: Disk throughput in MegaBytes per second. readOnly: true megabytesPerSecondOfWrite: type: number format: double description: Disk throughput in MegaBytes per second. readOnly: true numberOfReadOperationsPerSecond: type: number format: double description: Number of read operations per second for the disk. readOnly: true numberOfWriteOperationsPerSecond: type: number format: double description: Number of read and write operations per second for the disk. readOnly: true monthlyStorageCost: type: number format: double description: Estimated aggregate storage cost for a 31-day month for this disk. readOnly: true recommendedDiskType: type: string enum: - Unknown - Standard - Premium description: Storage type selected for this disk. x-ms-enum: name: AzureDiskType modelAsString: true readOnly: true recommendedDiskSize: type: string enum: - Unknown - Standard_S4 - Standard_S6 - Standard_S10 - Standard_S20 - Standard_S30 - Standard_S40 - Standard_S50 - Premium_P4 - Premium_P6 - Premium_P10 - Premium_P20 - Premium_P30 - Premium_P40 - Premium_P50 description: Recommended Azure size for the disk, given utilization data and preferences set on Assessment. readOnly: true x-ms-enum: name: AzureDiskSize modelAsString: true gigabytesForRecommendedDiskSize: type: integer format: int32 description: Gigabytes of storage provided by the recommended Azure disk size. readOnly: true suitability: type: string enum: - Unknown - NotSuitable - Suitable - ConditionallySuitable description: Whether this disk is suitable for Azure. readOnly: true x-ms-enum: name: CloudSuitability modelAsString: true suitabilityExplanation: type: string enum: - Unknown - NotApplicable - DiskSizeGreaterThanSupported - NoSuitableDiskSizeForIops - NoSuitableDiskSizeForThroughput - NoDiskSizeFoundInSelectedLocation - NoDiskSizeFoundForSelectedRedundancy - InternalErrorOccurredForDiskEvaluation description: If disk is suitable, this explains the reasons and mitigation steps. readOnly: true x-ms-enum: name: AzureDiskSuitabilityExplanation modelAsString: true DimensionScope: type: string description: The scope at which the quota is applied to. enum: - Workspace - Subscription x-ms-enum: name: DimensionScope modelAsString: true values: - name: Workspace value: Workspace description: The quota is applied to the Quantum Workspace. - name: Subscription value: Subscription description: The quota is applied to the Azure Subscription. SharedPrivateLinkResourceProperties: properties: privateLinkResourceId: type: string description: The resource id of the resource the shared private link resource is for. groupId: type: string description: The group id from the provider of resource the shared private link resource is for. requestMessage: type: string description: The request message for requesting approval of the shared private link resource. resourceRegion: type: string description: Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). externalDocs: description: List of all Azure resources which have a regional DNS configuration requirement can be found here. url: https://docs.microsoft.com/azure/private-link/private-endpoint-dns status: type: string description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected or other yet to be documented value. enum: - Pending - Approved - Rejected - Disconnected x-ms-enum: name: SharedPrivateLinkResourceStatus modelAsString: true values: - value: Pending name: Pending description: The shared private link resource has been created and is pending approval. - value: Approved name: Approved description: The shared private link resource is approved and is ready for use. - value: Rejected name: Rejected description: The shared private link resource has been rejected and cannot be used. - value: Disconnected name: Disconnected description: The shared private link resource has been removed from the service. provisioningState: type: string description: The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded, Incomplete or other yet to be documented value. enum: - Updating - Deleting - Failed - Succeeded - Incomplete x-ms-enum: name: SharedPrivateLinkResourceProvisioningState modelAsString: true values: - value: Updating name: Updating description: The shared private link resource is in the process of being created along with other resources for it to be fully functional. - value: Deleting name: Deleting description: The shared private link resource is in the process of being deleted. - value: Failed name: Failed description: The shared private link resource has failed to be provisioned or deleted. - value: Succeeded name: Succeeded description: The shared private link resource has finished provisioning and is ready for approval. - value: Incomplete name: Incomplete description: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. description: Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service. ActionGroupResource: description: An action group resource. type: object allOf: - $ref: '#/definitions/AzureResource' properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ActionGroup' description: The action groups properties of the resource. ClusterConfigFile: type: object description: Cluster configuration files. required: - fileName properties: fileName: type: string description: Configuration file name. example: hive-conf.xml. content: type: string description: Free form content of the entire configuration file. encoding: type: string description: This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. enum: - Base64 - None x-ms-enum: name: ContentEncoding modelAsString: true path: type: string description: Path of the config file if content is specified. values: type: object description: 'List of key value pairs where key represents a valid service configuration name and value represents the value of the config.' additionalProperties: type: string ErrorResponse_3: description: The error response. type: object properties: code: description: The error code. type: string readOnly: true message: description: The error message indicating why the operation failed. type: string readOnly: true MoveResourceErrorBody: properties: code: type: string readOnly: true description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: type: string readOnly: true description: A message describing the error, intended to be suitable for display in a user interface. target: type: string readOnly: true description: The target of the particular error. For example, the name of the property in error. details: type: array readOnly: true items: $ref: '#/definitions/MoveResourceErrorBody' description: A list of additional details about the error. description: An error response from the Azure Migrate service. JsonPatchDocument: type: array description: A JSONPatch document as defined by RFC 6902. items: $ref: '#/definitions/JsonPatchObject' x-ms-identifiers: [] GuestDiagnosticSettingsList: description: A list of guest diagnostic settings. properties: value: type: array items: $ref: '#/definitions/GuestDiagnosticSettingsResource' description: The list of guest diagnostic settings. nextLink: type: string description: Provides the link to retrieve the next set of elements. IdentityProfile: type: object description: Identity Profile with details of an MSI. required: - msiResourceId - msiClientId - msiObjectId properties: msiResourceId: type: string description: ResourceId of the MSI. format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.ManagedIdentity/userAssignedIdentities msiClientId: type: string description: ClientId of the MSI. pattern: ^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$ msiObjectId: type: string description: ObjectId of the MSI. pattern: ^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$ SshProfile: type: object description: Ssh profile for the cluster. required: - count properties: count: type: integer description: Number of ssh pods per cluster. format: int32 maximum: 5 minimum: 0 podPrefix: type: string description: Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //- readOnly: true ComponentsResource: properties: id: type: string readOnly: true description: Azure resource Id name: type: string description: Azure resource name readOnly: true type: type: string readOnly: true description: Azure resource type location: type: string description: Resource location x-ms-mutability: - create - read tags: additionalProperties: type: string description: Resource tags required: - location x-ms-azure-resource: true description: An azure resource object ConsoleProperties: type: object title: ConsoleProperties represents the properties of the virtual machine console. required: - sshPublicKey - enabled properties: detailedStatus: description: The more detailed status of the console. type: string enum: - Ready - Error x-ms-enum: modelAsString: true name: ConsoleDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true enabled: description: The indicator of whether the console access is enabled. type: string enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: ConsoleEnabled expiration: description: The date and time after which the key will be disallowed access. type: string format: date-time privateLinkServiceId: description: The resource ID of the private link service that is used to provide virtual machine console access. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.Network/privateLinkServices readOnly: true provisioningState: description: The provisioning state of the virtual machine console. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted x-ms-enum: modelAsString: true name: ConsoleProvisioningState readOnly: true sshPublicKey: $ref: '#/definitions/SshPublicKey' description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. virtualMachineAccessId: description: The unique identifier for the virtual machine that is used to access the console. type: string readOnly: true MoveSubscriptionsDefinition: description: The move subscriptions action definition type: object required: - resources properties: targetDelegatedProviderOffer: description: The delegated provider offer identifier (from the Admin context) that the subscriptions to be moved to. type: string resources: description: A collection of subscriptions to move to the target delegated provider offer. type: array items: type: string operationStatusProperties: type: object description: Operation status associated with the last patch request properties: status: enum: - Failed - Succeeded type: string x-ms-enum: name: operationStatusEnum modelAsString: true description: Operation status for the last patch request for this connection. readOnly: true id: type: string description: Operation status ID of the last patch request for this connection. readOnly: true message: type: string description: Message for the operation for the last patch request for this connection. readOnly: true ServiceConfigResult: type: object description: Cluster instance service config. properties: properties: x-ms-client-flatten: true description: Cluster instance service config properties. allOf: - $ref: '#/definitions/ServiceConfigListResultProperties' ThroughputPoolProperties: description: Properties to update Azure Cosmos DB throughput pool. type: object x-ms-mutability: - read - create - update properties: provisioningState: $ref: '#/definitions/ProvisioningState_2' description: A provisioning state of the ThroughputPool. maxThroughput: type: integer format: int32 description: Value for throughput to be shared among CosmosDB resources in the pool. SkuInfos: description: Collection of SKU information. type: object properties: resourceType: description: Resource type that this SKU applies to. type: string skus: description: List of SKUs the subscription is able to use. type: array items: $ref: '#/definitions/GlobalCsmSkuDescription' x-ms-identifiers: - name NodeProfile: type: object description: The node profile. required: - type - vmSize - count properties: type: type: string description: The node type. pattern: ^(head|Head|HEAD|worker|Worker|WORKER)$ vmSize: type: string description: The virtual machine SKU. pattern: ^[a-zA-Z0-9_\-]{0,256}$ count: description: The number of virtual machines. type: integer format: int32 minimum: 1 VirtualHubRouteTableV2Properties: properties: routes: type: array description: List of all routes. items: $ref: '#/definitions/VirtualHubRouteV2' attachedConnections: type: array description: List of all connections attached to this route table v2. items: type: string provisioningState: $ref: ./network.json#/definitions/ProvisioningState readOnly: true description: The provisioning state of the virtual hub route table v2 resource. description: Parameters for VirtualHubRouteTableV2. DownloadUrl: type: object description: Download URL for assessment report. properties: assessmentReportUrl: type: string description: Hyperlink to download report. readOnly: true expirationTime: type: string format: date-time description: Expiry date of download url. readOnly: true AlertRuleAnyOfOrLeafCondition: description: "An Activity Log Alert rule condition that is met when all its member conditions are met.\nEach condition can be of one of the following types:\n__Important__: Each type has its unique subset of properties. Properties from different types CANNOT exist in one condition.\n * __Leaf Condition -__ must contain 'field' and either 'equals' or 'containsAny'.\n _Please note, 'anyOf' should __not__ be set in a Leaf Condition._\n * __AnyOf Condition -__ must contain __only__ 'anyOf' (which is an array of Leaf Conditions).\n _Please note, 'field', 'equals' and 'containsAny' should __not__ be set in an AnyOf Condition._\n" type: object allOf: - $ref: '#/definitions/AlertRuleLeafCondition' properties: anyOf: title: An Activity Log Alert rule 'anyOf' condition. description: An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met. type: array items: $ref: '#/definitions/AlertRuleLeafCondition' x-ms-identifiers: [] ClusterAvailableUpgradeVersion: type: object title: ClusterAvailableUpgradeVersion represents the various cluster upgrade parameters. properties: controlImpact: description: The indicator of whether the control plane will be impacted during the upgrade. type: string enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: ControlImpact readOnly: true expectedDuration: description: The expected duration needed for this upgrade. type: string readOnly: true impactDescription: description: The impact description including the specific details and release notes. type: string readOnly: true supportExpiryDate: description: The last date the version of the platform is supported. type: string readOnly: true targetClusterVersion: description: The target version this cluster will be upgraded to. type: string readOnly: true workloadImpact: description: The indicator of whether the workload will be impacted during the upgrade. type: string enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: WorkloadImpact readOnly: true PublicNetworkAccessType_2: type: string description: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). default: Disabled enum: - Enabled - Disabled x-ms-enum: name: PublicNetworkAccessType modelAsString: true values: - value: Enabled description: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. - value: Disabled description: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. BareMetalMachinePowerOffParameters: type: object title: BareMetalMachinePowerOffParameters represents the body of the request to power off bare metal machine. properties: skipShutdown: description: The indicator of whether to skip the graceful OS shutdown and power off the bare metal machine immediately. type: string default: 'False' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: BareMetalMachineSkipShutdown HealthMonitorStateChangeList: title: Information about the health state changes of the monitor within the provided time window. type: object readOnly: true properties: value: description: Array of health state changes within the specified time window. type: array items: $ref: '#/definitions/HealthMonitorStateChange' nextLink: description: Link to next page if the list is too long. type: string EtwProviderConfiguration: type: object required: - id - events properties: id: type: string events: type: array items: $ref: '#/definitions/EtwEventConfiguration' ModelingInputData: description: The configuration to raw CDM data to be used as Modeling resource input. type: object properties: connectionString: description: Connection string to raw input data. type: string CloudError_11: type: object properties: error: $ref: '#/definitions/CloudErrorBody_9' description: Describes a particular API error with an error code and a message. message: type: string description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). description: Contains information about an API error. x-ms-external: true Setting: description: Describes a setting for the container. type: object properties: name: description: The name of the setting. type: string value: description: The value of the setting. type: string AseRegion: description: ASE region. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: ASE region resource specific properties type: object properties: displayName: description: Display name for region. type: string readOnly: true standard: description: Is region standard. type: boolean readOnly: true dedicatedHost: description: Dedicated host enabled. type: boolean readOnly: true zoneRedundant: description: Zone redundant deployment enabled. type: boolean readOnly: true availableSku: description: Available Skus in region. type: array items: type: string availableOS: description: Available OSs in region. type: array items: type: string x-ms-client-flatten: true AvailableSkusResult: description: The available skus operation response. type: object properties: value: description: List of available skus. type: array items: $ref: '#/definitions/SkuInformation' readOnly: true nextLink: description: Link for the next set of skus. type: string ClusterScopeSettings: type: object description: Extension scope settings properties: properties: type: object x-ms-client-flatten: true description: Extension scope settings properties: allowMultipleInstances: type: boolean description: Describes if multiple instances of the extension are allowed defaultReleaseNamespace: type: string description: Default extension release namespace allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource DnsResourceReferenceRequestProperties: type: object properties: targetResources: type: array items: $ref: '#/definitions/SubResource' description: A list of references to azure resources for which referencing dns records need to be queried. description: Represents the properties of the Dns Resource Reference Request. ProjectResultList_2: type: object description: List of projects. properties: value: type: array description: List of projects. items: $ref: '#/definitions/MigrateProject' nextLink: type: string AzureDevOpsProject: description: Azure DevOps Project Proxy Resource. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/AzureDevOpsProjectProperties' AssessedMachineProperties: type: object description: Properties of an assessed machine. properties: groups: type: array description: List of references to the groups that the machine is member of. readOnly: true items: type: string readOnly: true description: Reference to a group that this machine is member of. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName} discoveredTimestamp: type: string format: date-time description: Time when this machine was discovered by Azure Migrate agent. Date-Time represented in ISO-8601 format. readOnly: true bootType: type: string description: Boot type of the machine. enum: - Unknown - EFI - BIOS readOnly: true x-ms-enum: name: MachineBootType modelAsString: true datacenterContainer: type: string description: Container defined in the management solution that this machine is part of in the datacenter. readOnly: true datacenterManagementServer: type: string description: Name of the server hosting the datacenter management solution. readOnly: true datacenterMachineId: type: string description: ID of the machine as tracked by the datacenter management solution. readOnly: true datacenterManagementServerId: type: string description: ID of the server hosting the datacenter management solution. readOnly: true description: type: string description: Description of the machine readOnly: true displayName: type: string description: User readable name of the machine as defined by the user in their private datacenter. readOnly: true megabytesOfMemory: type: number format: double description: Memory in Megabytes. readOnly: true numberOfCores: type: integer format: int32 description: Processor count. readOnly: true operatingSystem: type: string description: Operating System of the machine. readOnly: true monthlyBandwidthCost: type: number format: double description: Monthly network cost estimate for the network adapters that are attached to this machine as a group, for a 31-day month. readOnly: true monthlyStorageCost: type: number format: double description: Monthly storage cost estimate for the disks that are attached to this machine as a group, for a 31-day month. readOnly: true disks: type: object description: Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object. readOnly: true additionalProperties: $ref: '#/definitions/AssessedDisk' networkAdapters: type: object description: Dictionary of network adapters attached to the machine. Key is name of the adapter. Value is a network adapter object. readOnly: true additionalProperties: $ref: '#/definitions/AssessedNetworkAdapter' recommendedSize: type: string enum: - Unknown - Basic_A0 - Basic_A1 - Basic_A2 - Basic_A3 - Basic_A4 - Standard_A0 - Standard_A1 - Standard_A2 - Standard_A3 - Standard_A4 - Standard_A5 - Standard_A6 - Standard_A7 - Standard_A8 - Standard_A9 - Standard_A10 - Standard_A11 - Standard_A1_v2 - Standard_A2_v2 - Standard_A4_v2 - Standard_A8_v2 - Standard_A2m_v2 - Standard_A4m_v2 - Standard_A8m_v2 - Standard_D1 - Standard_D2 - Standard_D3 - Standard_D4 - Standard_D11 - Standard_D12 - Standard_D13 - Standard_D14 - Standard_D1_v2 - Standard_D2_v2 - Standard_D3_v2 - Standard_D4_v2 - Standard_D5_v2 - Standard_D11_v2 - Standard_D12_v2 - Standard_D13_v2 - Standard_D14_v2 - Standard_D15_v2 - Standard_DS1 - Standard_DS2 - Standard_DS3 - Standard_DS4 - Standard_DS11 - Standard_DS12 - Standard_DS13 - Standard_DS14 - Standard_DS1_v2 - Standard_DS2_v2 - Standard_DS3_v2 - Standard_DS4_v2 - Standard_DS5_v2 - Standard_DS11_v2 - Standard_DS12_v2 - Standard_DS13_v2 - Standard_DS14_v2 - Standard_DS15_v2 - Standard_F1 - Standard_F2 - Standard_F4 - Standard_F8 - Standard_F16 - Standard_F1s - Standard_F2s - Standard_F4s - Standard_F8s - Standard_F16s - Standard_G1 - Standard_G2 - Standard_G3 - Standard_G4 - Standard_G5 - Standard_GS1 - Standard_GS2 - Standard_GS3 - Standard_GS4 - Standard_GS5 - Standard_H8 - Standard_H16 - Standard_H8m - Standard_H16m - Standard_H16r - Standard_H16mr - Standard_L4s - Standard_L8s - Standard_L16s - Standard_L32s description: Recommended Azure size for this machine. readOnly: true x-ms-enum: name: AzureVmSize modelAsString: true numberOfCoresForRecommendedSize: type: integer format: int32 description: Number of CPU cores in the Recommended Azure VM Size. readOnly: true megabytesOfMemoryForRecommendedSize: type: number format: double description: Megabytes of memory in the Recommended Azure VM Size. readOnly: true monthlyComputeCostForRecommendedSize: type: number format: double description: Compute Cost for a 31-day month, if the machine is migrated to Azure with the Recommended Size. readOnly: true percentageCoresUtilization: type: number format: double description: Utilization percentage of the processor core as observed in the private data center, in the Time Range selected on Assessment, reported as the Percentile value based on the percentile number selected in assessment. readOnly: true percentageMemoryUtilization: type: number format: double description: Utilization percentage of the memory as observed in the private data center, in the Time Range selected on Assessment, reported as the Percentile value based on the percentile number selected in assessment. readOnly: true suitability: type: string enum: - Unknown - NotSuitable - Suitable - ConditionallySuitable description: Whether machine is suitable for migration to Azure. readOnly: true x-ms-enum: name: CloudSuitability modelAsString: true suitabilityExplanation: type: string enum: - Unknown - NotApplicable - GuestOperatingSystemArchitectureNotSupported - GuestOperatingSystemNotSupported - BootTypeNotSupported - MoreDisksThanSupported - NoSuitableVmSizeFound - OneOrMoreDisksNotSuitable - OneOrMoreAdaptersNotSuitable - InternalErrorOccuredDuringComputeEvaluation - InternalErrorOccuredDuringStorageEvaluation - InternalErrorOccuredDuringNetworkEvaluation - NoVmSizeSupportsStoragePerformance - NoVmSizeSupportsNetworkPerformance - NoVmSizeForSelectedPricingTier - NoVmSizeForSelectedAzureLocation - CheckRedHatLinuxVersion - CheckOpenSuseLinuxVersion - CheckWindowsServer2008R2Version - CheckCentOsVersion - CheckDebianLinuxVersion - CheckSuseLinuxVersion - CheckOracleLinuxVersion - CheckUbuntuLinuxVersion - CheckCoreOsLinuxVersion - WindowsServerVersionConditionallySupported - NoGuestOperatingSystemConditionallySupported - WindowsClientVersionsConditionallySupported description: If machine is not ready to be migrated, this explains the reasons and mitigation steps. readOnly: true x-ms-enum: name: AzureVmSuitabilityExplanation modelAsString: true createdTimestamp: type: string format: date-time description: Time when this machine was created. Date-Time represented in ISO-8601 format. readOnly: true updatedTimestamp: type: string format: date-time description: Time when this machine was last updated. Date-Time represented in ISO-8601 format. readOnly: true MonitoringInstanceProperties: description: The properties of a SCOM instance resource type: object properties: productVersion: description: SCOM product version to be installed on instance type: string readOnly: true vNetSubnetId: description: Virtual Network subnet id on which Aquila instance will be provisioned type: string managementEndpoints: description: List of management server endpoints readOnly: true type: array items: $ref: '#/definitions/ManagementServerProperties' x-ms-identifiers: [] databaseInstance: description: The database instance where the SCOM Operational and Warehouse databases will be stored. $ref: '#/definitions/DatabaseInstanceProperties' domainController: description: Domain controller details $ref: '#/definitions/DomainControllerProperties' domainUserCredentials: description: Domain user which will be used to join VMs to domain and login to VMs. $ref: '#/definitions/DomainUserCredentials' gmsaDetails: description: Gmsa Details for load balancer and vmss $ref: '#/definitions/GmsaDetails' azureHybridBenefit: description: The properties to enable Azure Hybrid benefit for various SCOM infrastructure license. $ref: '#/definitions/AzureHybridBenefitProperties' provisioningState: description: Gets or sets the provisioning state. type: string readOnly: true logAnalyticsProperties: description: Details of Log Analytics workspace and data being ingested. readOnly: true $ref: '#/definitions/logAnalyticsConfiguration' operationsStatus: description: Gets status of current and latest SCOM managed instance operations. readOnly: true type: array items: $ref: '#/definitions/ManagedInstanceOperationStatus' x-ms-identifiers: - id ValidateProperties: description: App properties used for validation. type: object properties: serverFarmId: description: ARM resource ID of an App Service plan that would host the app. type: string skuName: description: Name of the target SKU for the App Service plan. type: string needLinuxWorkers: description: true if App Service plan is for Linux workers; otherwise, false. type: boolean isSpot: description: true if App Service plan is for Spot instances; otherwise, false. type: boolean capacity: format: int32 description: Target capacity of the App Service plan (number of VMs). minimum: 1 type: integer hostingEnvironment: description: Name of App Service Environment where app or App Service plan should be created. type: string isXenon: description: true if App Service plan is running as a windows container type: boolean containerRegistryBaseUrl: description: Base URL of the container registry type: string containerRegistryUsername: description: Username for to access the container registry type: string containerRegistryPassword: description: Password for to access the container registry type: string containerImageRepository: description: Repository name (image name) type: string containerImageTag: description: Image tag type: string containerImagePlatform: description: Platform (windows or linux) type: string appServiceEnvironment: $ref: ./CommonDefinitions.json#/definitions/AppServiceEnvironment description: App Service Environment Properties NetworkAccessControl: properties: integration: $ref: '#/definitions/GroupLevelAccessControl' description: Public network access for integration group. x-nullable: true ingestion: $ref: '#/definitions/GroupLevelAccessControl' description: Public network access for ingestion group. x-nullable: true consumption: $ref: '#/definitions/GroupLevelAccessControl' description: Public network access for consumption group. x-nullable: true type: object description: Network access control for video analyzer account. LogAnalyticsQueryPackListResult: description: Describes the list of Log Analytics QueryPack resources. required: - value properties: value: type: array description: List of Log Analytics QueryPack definitions. items: $ref: '#/definitions/LogAnalyticsQueryPack' nextLink: type: string description: The URI to get the next set of Log Analytics QueryPack definitions if too many QueryPacks where returned in the result set. VideoAnalyzerUpdate: properties: tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags. properties: $ref: '#/definitions/VideoAnalyzerPropertiesUpdate' description: The resource properties. x-ms-client-flatten: true identity: $ref: '#/definitions/VideoAnalyzerIdentity' description: The identities associated to the Video Analyzer resource. type: object description: The update operation for a Video Analyzer account. TransportAvailabilityResponse: description: Transport options available for given sku in a region. type: object properties: transportAvailabilityDetails: description: List of transport availability details for given region type: array items: $ref: '#/definitions/TransportAvailabilityDetails' readOnly: true VpnServerConfigurationsResponse: properties: vpnServerConfigurationResourceIds: type: array items: type: string description: VpnServerConfiguration partial resource uri. description: List of VpnServerConfigurations associated with VirtualWan. description: VpnServerConfigurations list associated with VirtualWan Response. BgpConnection: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/BgpConnectionProperties' description: The properties of the Bgp connections. name: type: string description: Name of the connection. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. type: type: string readOnly: true description: Connection type. allOf: - $ref: ./network.json#/definitions/SubResource description: Virtual Appliance Site resource. HubRoute: required: - name - destinationType - destinations - nextHopType - nextHop properties: name: type: string description: The name of the Route that is unique within a RouteTable. This name can be used to access this route. destinationType: type: string description: 'The type of destinations (eg: CIDR, ResourceId, Service).' destinations: type: array description: List of all destinations. items: type: string nextHopType: type: string description: 'The type of next hop (eg: ResourceId).' nextHop: type: string description: NextHop resource ID. description: RouteTable route. RemediationFilters: properties: locations: type: array items: type: string description: The resource locations that will be remediated. description: The filters that will be applied to determine which resources to remediate. EncryptionProperties: description: The container group encryption properties. type: object properties: vaultBaseUrl: description: The keyvault base url. type: string keyName: description: The encryption key name. type: string keyVersion: description: The encryption key version. type: string identity: type: string description: The keyvault managed identity. required: - vaultBaseUrl - keyName - keyVersion BillingMeterCollection: description: Collection of Billing Meters required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/BillingMeter' nextLink: description: Link to next page of resources. type: string readOnly: true MoveCollectionResultList: description: Defines the collection of move collections. type: object properties: value: description: Gets the list of move collections. type: array items: $ref: '#/definitions/MoveCollection' nextLink: description: Gets the value of next link. type: string ServicePrincipalTagHealthReport: description: A report of the health status of a tag on an identity application service principal. type: object properties: servicePrincipalTag: description: The tag. type: string status: description: The health status for the tag. $ref: '#/definitions/HealthStatus' selectedResource: type: object description: A resource selected from ARM properties: name: type: string description: Name of the connection id: type: string description: Id of the connection location: type: string description: Location of the connection x-ms-mutability: - create - read subscriptionName: type: string description: Name of the subscription with the connection required: - id VpnConnectionPacketCaptureStartParameters: description: Vpn Connection packet capture parameters supplied to start packet capture on gateway connection. properties: filterData: type: string description: Start Packet capture parameters on vpn connection. linkConnectionNames: type: array description: List of site link connection names. items: type: string ListCommands: description: List of commands for cluster. type: object properties: value: description: Container for array of commands. type: array readOnly: true items: $ref: '#/definitions/CommandPublicResource' Identity_3: description: Defines the MSI properties of the Move Collection. type: object properties: type: $ref: '#/definitions/ResourceIdentityType' principalId: description: Gets or sets the principal id. type: string tenantId: description: Gets or sets the tenant id. type: string DnsResourceReferenceRequest: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/DnsResourceReferenceRequestProperties' description: The properties of the Resource Reference Request. description: Represents the properties of the Dns Resource Reference Request. PerimeterAssociableResourceProperties: type: object properties: displayName: readOnly: true type: string description: A friendly name for the properties of perimeter associable resources. resourceType: readOnly: true type: string description: Resource type/provider name. publicDnsZones: readOnly: true type: array items: type: string description: Public DNS zone names of the resources. description: Properties of the perimeter associable resources. ListVirtualWANsResult: description: Result of the request to list VirtualWANs. It contains a list of VirtualWANs and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VirtualWAN' description: List of VirtualWANs. nextLink: type: string description: URL to get the next set of operation list results if there are any. ApplicationInsightsComponentProperties: description: Properties that define an Application Insights component resource. properties: ApplicationId: type: string description: The unique ID of your application. This field mirrors the 'Name' field and cannot be changed. readOnly: true AppId: type: string readOnly: true description: Application Insights Unique ID for your Application. Name: type: string readOnly: true description: Application name. Application_Type: type: string description: Type of application being monitored. default: web enum: - web - other x-ms-enum: name: ApplicationType modelAsString: true x-ms-mutability: - create - read Flow_Type: type: string description: Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to 'Bluefield' when creating/updating a component via the REST API. default: Bluefield enum: - Bluefield x-ms-enum: name: FlowType modelAsString: true Request_Source: type: string description: Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'. default: rest enum: - rest x-ms-enum: name: RequestSource modelAsString: true InstrumentationKey: type: string readOnly: true description: Application Insights Instrumentation key. A read-only value that applications can use to identify the destination for all telemetry sent to Azure Application Insights. This value will be supplied upon construction of each new Application Insights component. CreationDate: type: string readOnly: true description: Creation Date for the Application Insights component, in ISO 8601 format. format: date-time TenantId: type: string readOnly: true description: Azure Tenant Id. HockeyAppId: type: string description: The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp. externalDocs: url: https://aka.ms/ewjuel HockeyAppToken: type: string description: Token used to authenticate communications with between Application Insights and HockeyApp. readOnly: true externalDocs: url: https://aka.ms/sls76s provisioningState: type: string description: 'Current state of this component: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.' readOnly: true SamplingPercentage: type: number format: double description: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry. externalDocs: url: https://aka.ms/sl0yqd ConnectionString: type: string readOnly: true description: Application Insights component connection string. RetentionInDays: type: integer description: Retention period in days. readOnly: true DisableIpMasking: type: boolean description: Disable IP masking. ImmediatePurgeDataOn30Days: type: boolean description: Purge data immediately after 30 days. WorkspaceResourceId: type: string description: Resource Id of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property. LaMigrationDate: type: string readOnly: true description: The date which the component got migrated to LA, in ISO 8601 format. format: date-time PrivateLinkScopedResources: readOnly: true type: array items: $ref: '#/definitions/PrivateLinkScopedResource' description: List of linked private link scope resources. publicNetworkAccessForIngestion: description: The network access type for accessing Application Insights ingestion. $ref: '#/definitions/PublicNetworkAccessType' publicNetworkAccessForQuery: description: The network access type for accessing Application Insights query. $ref: '#/definitions/PublicNetworkAccessType' IngestionMode: type: string description: Indicates the flow of the ingestion. default: LogAnalytics enum: - ApplicationInsights - ApplicationInsightsWithDiagnosticSettings - LogAnalytics x-ms-enum: name: IngestionMode modelAsString: true DisableLocalAuth: type: boolean description: Disable Non-AAD based Auth. ForceCustomerStorageForProfiler: type: boolean description: Force users to create their own storage account for profiler and debugger. required: - Application_Type AzureDevOpsProjectMetadata: description: Project onboarding info. type: object properties: name: description: Gets or sets name of the AzureDevOps Project. type: string autoDiscovery: $ref: '#/definitions/AutoDiscovery' repos: description: Gets or sets repositories. type: array items: type: string x-ms-identifiers: [] SupportInfoModel: type: object properties: productSku: type: string description: product SKU associated with given resource productSerial: type: string description: product Serial associated with given resource accountRegistrationStatus: $ref: '#/definitions/RegistrationStatus' description: account registered in Customer Support Portal accountId: type: string description: Support account associated with given resource freeTrial: $ref: '#/definitions/EnableStatus' description: Product usage is in free trial period freeTrialDaysLeft: type: integer format: int32 description: Free trial days remaining freeTrialCreditLeft: type: integer format: int32 description: Free trial credit remaining helpURL: type: string description: URL for paloaltonetworks live community supportURL: type: string description: URL for paloaltonetworks Customer Service Portal registerURL: type: string description: URL for registering product in paloaltonetworks Customer Service Portal hubUrl: type: string description: URL for Strata Cloud Manager credits: type: integer format: int32 description: credits purchased, unit per hour monthlyCreditLeft: type: integer format: int32 description: monthly credit is computed as credits * days in calendar month startDateForCredits: type: string description: date in format yyyy-mm-dd endDateForCredits: type: string description: date in format yyyy-mm-dd description: Support information for the service AllowType: description: Whether to allow firewall rules. type: string enum: - 'true' - 'false' x-ms-enum: name: allowType modelAsString: true PrivateEndpointConnectionProvisioningState: type: string readOnly: true description: The current provisioning state. enum: - Succeeded - Creating - Deleting - Failed - Updating - InternalError - Canceled x-ms-enum: name: PrivateEndpointConnectionProvisioningState modelAsString: true AuthenticationBase: discriminator: '@type' properties: '@type': type: string description: The discriminator for derived types. type: object required: - '@type' description: Base class for access policies authentication methods. AzureDevOpsConnectorListResponse: type: object properties: value: description: Gets or sets list of resources. type: array items: $ref: '#/definitions/AzureDevOpsConnector' x-ms-identifiers: [] nextLink: description: Gets or sets next link to scroll over the results. type: string CommonEncryptionCbcs: properties: enabledProtocols: $ref: '#/definitions/EnabledProtocols' description: Representing supported protocols clearTracks: type: array items: $ref: '#/definitions/TrackSelection' description: Representing which tracks should not be encrypted contentKeys: $ref: '#/definitions/StreamingPolicyContentKeys' description: Representing default content key for each encryption scheme and separate content keys for specific tracks drm: $ref: '#/definitions/CbcsDrmConfiguration' description: Configuration of DRMs for current encryption scheme type: object description: Class for CommonEncryptionCbcs encryption scheme TagsObject_2: type: object properties: tags: type: object additionalProperties: type: string description: Resource tags. description: Tags object for patch operations. CorsRuleList: description: The list of CORS details. type: array items: $ref: '#/definitions/CorsRule' x-ms-identifiers: [] PagedQuota: type: object description: Paged collection of Quota items properties: value: type: array description: The Quota items on this page items: $ref: '#/definitions/Quota' x-ms-identifiers: [] nextLink: type: string format: uri description: The link to the next page of items required: - value BackupSchedule: type: object properties: scheduleName: description: The unique identifier of backup schedule. type: string cronExpression: description: The cron expression that defines when you want to back up your data. type: string retentionInHours: description: The retention period (hours) of the backups. If you want to retain data forever, set retention to 0. type: integer format: int32 ComponentPolicyStatesQueryResults: type: object description: Query results. properties: '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string '@odata.count': description: OData entity count; represents the number of policy state records returned. type: integer format: int32 minimum: 0 value: description: Query results. type: array items: $ref: '#/definitions/ComponentPolicyState' x-ms-identifiers: [] MediaServiceCollection: description: The collection of Media Service resources. properties: value: description: The collection of Media Service resources. type: array items: $ref: '#/definitions/MediaService' TagUpdate: description: Request payload used to update an existing resource's tags. type: object properties: tags: type: object description: List of key value pairs that describe the resource. This will overwrite the existing tags. additionalProperties: type: string AccessModeSettings: type: object description: Properties that define the scope private link mode settings. properties: queryAccessMode: description: Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array. $ref: '#/definitions/AccessMode' ingestionAccessMode: description: Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array. $ref: '#/definitions/AccessMode' exclusions: description: List of exclusions that override the default access mode settings for specific private endpoint connections. type: array items: $ref: '#/definitions/AccessModeSettingsExclusion' required: - queryAccessMode - ingestionAccessMode CloudServicesNetworkProperties: type: object title: CloudServicesNetworkProperties represents properties of the cloud services network. properties: additionalEgressEndpoints: description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. type: array items: $ref: '#/definitions/EgressEndpoint' x-ms-identifiers: [] associatedResourceIds: description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. type: array items: type: string readOnly: true clusterId: description: The resource ID of the Network Cloud cluster this cloud services network is associated with. type: string format: arm-id readOnly: true detailedStatus: description: The more detailed status of the cloud services network. type: string enum: - Error - Available - Provisioning x-ms-enum: modelAsString: true name: CloudServicesNetworkDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true enableDefaultEgressEndpoints: description: The indicator of whether the platform default endpoints are allowed for the egress traffic. type: string default: 'True' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: CloudServicesNetworkEnableDefaultEgressEndpoints enabledEgressEndpoints: description: The full list of additional and default egress endpoints that are currently enabled. type: array items: $ref: '#/definitions/EgressEndpoint' x-ms-identifiers: [] readOnly: true hybridAksClustersAssociatedIds: description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network. type: array items: type: string readOnly: true interfaceName: description: The name of the interface that will be present in the virtual machine to represent this network. type: string readOnly: true provisioningState: description: The provisioning state of the cloud services network. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted x-ms-enum: modelAsString: true name: CloudServicesNetworkProvisioningState readOnly: true virtualMachinesAssociatedIds: description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network. type: array items: type: string readOnly: true DisabledDataExfiltrationOption: type: string enum: - All x-ms-enum: name: SearchDisabledDataExfiltrationOption modelAsString: true values: - value: All name: All description: Indicates that all data exfiltration scenarios are disabled. description: A specific data exfiltration scenario that is disabled for the service. ResourceRequests: description: The resource requests. type: object required: - memoryInGB - cpu properties: memoryInGB: description: The memory request in GB of this container instance. type: number format: double cpu: description: The CPU request of this container instance. type: number format: double gpu: description: The GPU request of this container instance. $ref: '#/definitions/GpuResource' DataSource: type: object required: - kind - configuration - sinks properties: kind: type: string enum: - PerformanceCounter - ETWProviders - WindowsEventLogs description: Datasource kind configuration: type: object $ref: '#/definitions/DataSourceConfiguration' sinks: type: array items: $ref: '#/definitions/SinkConfiguration' description: Data source object contains configuration to collect telemetry and one or more sinks to send that telemetry data to Endpoint: properties: endpointUrl: type: string description: The URL of the endpoint. type: type: string enum: - ClientApi x-ms-enum: name: VideoAnalyzerEndpointType values: - value: ClientApi description: The client API endpoint. modelAsString: true description: The type of the endpoint. type: object required: - type description: The endpoint details. FlinkCatalogOptions: type: object description: Flink cluster catalog options. properties: hive: $ref: '#/definitions/FlinkHiveCatalogOption' ResourceRequests_2: description: 'This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits. ' type: object properties: memoryInGB: description: The memory request in GB for this container. type: number format: double cpu: description: Requested number of CPU cores. At present, only full cores are supported. type: number format: double required: - memoryInGB - cpu LinkerResource: type: object description: Linker of source and target resource allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource description: The resource model definition for an Azure Resource Manager proxy resource. required: - properties properties: properties: description: The properties of the Linker. $ref: '#/definitions/LinkerProperties' x-ms-client-flatten: true systemData: x-nullable: true readOnly: true $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData description: The system data. TrinoUserPlugins: type: object description: Trino user plugins spec properties: plugins: type: array description: Trino user plugins. items: $ref: '#/definitions/TrinoUserPlugin' x-ms-identifiers: [] VideoAnalyzerOperationStatus: properties: name: type: string description: Operation identifier. id: type: string description: Operation resource ID. startTime: type: string description: Operation start time. endTime: type: string description: Operation end time. status: type: string description: Operation status. error: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail x-nullable: true type: object required: - name description: Status of video analyzer operation. VideoAnalyzer: allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource properties: properties: $ref: '#/definitions/VideoAnalyzerProperties' description: The resource properties. x-ms-client-flatten: true identity: $ref: '#/definitions/VideoAnalyzerIdentity' description: The identities associated to the Video Analyzer resource. type: object description: The Video Analyzer account. ProvisioningState_2: description: The provisioning state of the resource. type: string enum: - Succeeded - Failed - Canceled - Updating x-ms-enum: name: status modelAsString: true readOnly: true HealthMonitorProperties: description: Properties of the monitor. type: object properties: monitorName: description: Human-readable name of the monitor. type: string example: 'logical-disks|C:' monitorType: description: Type of the monitor. type: string example: logical-disks|* monitoredObject: description: Dynamic monitored object of the monitor. type: string example: 'C:' parentMonitorName: description: Name of the parent monitor. type: string example: logical-disks previousMonitorState: description: Previous health state of the monitor. $ref: '#/definitions/HealthState_3' example: Healthy currentMonitorState: description: Current health state of the monitor. $ref: '#/definitions/HealthState_3' example: Healthy evaluationTimestamp: description: Timestamp of the monitor's last health evaluation. type: string example: '2020-02-15T20:20:18.5765757Z' currentStateFirstObservedTimestamp: description: Timestamp of the monitor's last health state change. type: string example: 2020-02-15T20:20:1.5765757Z lastReportedTimestamp: description: Timestamp of the monitor's last reported health state. type: string example: 2020-02-15T20:20:1.5765757Z evidence: description: Evidence validating the monitor's current health state. type: object monitorConfiguration: description: The configuration settings at the time of the monitor's health evaluation. type: object ConnectedClusterProvisioningState: type: string description: The current deployment state of connectedClusters. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true ContainerGroupSubnetId: description: Container group subnet information. type: object properties: id: description: Resource ID of virtual network and subnet. type: string name: description: Friendly name for the subnet. type: string required: - id GuestDiagnosticSettingsPatchResource: description: An diagnostic settings object for the body of patch operations. properties: tags: additionalProperties: type: string description: Resource tags properties: x-ms-client-flatten: true $ref: '#/definitions/GuestDiagnosticSettings' description: The diagnostic settings for an update operation. KeySetUserStatus: type: object title: KeySetUserStatus represents the status of the key set user. properties: azureUserName: description: The user name that will be used for access. type: string readOnly: true status: description: The indicator of whether the user is currently deployed for access. type: string enum: - Active - Invalid x-ms-enum: modelAsString: true name: BareMetalMachineKeySetUserSetupStatus readOnly: true statusMessage: description: The additional information describing the current status of this user, if any available. type: string maxLength: 256 readOnly: true PrivateLinkServiceConnectionStateProperty: type: object description: State of the private endpoint connection. required: - status - description properties: status: description: The private link service connection status. type: string description: description: The private link service connection description. type: string actionsRequired: description: The actions required for private link service connection. type: string readOnly: true L3NetworkAttachmentConfiguration: type: object title: L3NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 3 network. required: - networkId properties: ipamEnabled: description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. type: string default: 'False' enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: L3NetworkConfigurationIpamEnabled x-ms-mutability: - read - create networkId: description: The resource ID of the network that is being configured for attachment. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.NetworkCloud/l3Networks x-ms-mutability: - read - create pluginType: description: The indicator of how this network will be utilized by the Kubernetes cluster. type: string default: SRIOV enum: - DPDK - SRIOV - OSDevice - MACVLAN - IPVLAN x-ms-enum: modelAsString: true name: KubernetesPluginType x-ms-mutability: - read - create ListVpnConnectionsResult: description: Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnConnection' description: List of Vpn Connections. nextLink: type: string description: URL to get the next set of operation list results if there are any. ConsolePatchProperties: type: object title: ConsolePatchProperties represents the properties of the virtual machine console that can be patched. properties: enabled: description: The indicator of whether the console access is enabled. type: string enum: - 'True' - 'False' x-ms-enum: modelAsString: true name: ConsoleEnabled expiration: description: The date and time after which the key will be disallowed access. type: string format: date-time sshPublicKey: $ref: '#/definitions/SshPublicKey' description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. MachineSkuSlot: type: object title: MachineSkuSlot represents a single SKU and rack slot associated with the machine. properties: properties: $ref: '#/definitions/MachineSkuProperties' description: The list of the resource properties. x-ms-client-flatten: true rackSlot: description: The position in the rack for the machine. type: integer format: int64 readOnly: true AlertRulePatchProperties: type: object description: An Activity Log Alert rule properties for patch operations. properties: enabled: description: Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. type: boolean default: true Identity_2: 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. NetworkConfiguration: type: object title: NetworkConfiguration specifies the Kubernetes cluster network related configuration. required: - cloudServicesNetworkId - cniNetworkId properties: attachedNetworkConfiguration: $ref: '#/definitions/AttachedNetworkConfiguration' description: The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster. x-ms-mutability: - read - create bgpServiceLoadBalancerConfiguration: $ref: '#/definitions/BgpServiceLoadBalancerConfiguration' description: The configuration of the BGP service load balancer for this Kubernetes cluster. x-ms-mutability: - read - create cloudServicesNetworkId: description: The resource ID of the associated Cloud Services network. type: string format: arm-id x-ms-mutability: - read - create cniNetworkId: description: The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network. type: string format: arm-id x-ms-mutability: - read - create dnsServiceIp: description: The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR. type: string x-ms-mutability: - read - create podCidrs: description: The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. type: array items: type: string x-ms-mutability: - read - create serviceCidrs: description: The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. type: array items: type: string x-ms-mutability: - read - create ContainerGroup: description: A container group. allOf: - $ref: '#/definitions/Resource_3' - $ref: '#/definitions/ContainerGroupProperties' GmsaDetails: description: Gmsa Details type: object properties: loadBalancerIP: description: Frontend IP configuration for Load Balancer, which should be an available IP in customer VNet type: string gmsaAccount: description: gMSA account under which context all Management Server services will run type: string managementServerGroupName: description: OnPrem AD Computer Group where we will join VMs for ease of management type: string dnsName: description: Frontend DNS name for Load Balancer which will be used by Agents to initiate communication type: string L2NetworkPatchParameters: type: object title: L2NetworkPatchParameters represents the body of the request to patch the L2 network. properties: tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string ClusterComponents: type: array description: Component list of this cluster type and version. readOnly: true items: type: object properties: name: type: string version: type: string x-ms-identifiers: [] example: - name: HDFS version: 1.2.3 - name: HIVE version: 1.2.3 AzureBareMetalInstanceProperties: properties: hardwareProfile: $ref: '#/definitions/HardwareProfile' description: Specifies the hardware settings for the AzureBareMetal instance. storageProfile: $ref: '#/definitions/StorageProfile' description: Specifies the storage settings for the AzureBareMetal instance disks. osProfile: $ref: '#/definitions/OSProfile' description: Specifies the operating system settings for the AzureBareMetal instance. networkProfile: $ref: '#/definitions/NetworkProfile' description: Specifies the network settings for the AzureBareMetal instance. azureBareMetalInstanceId: readOnly: true type: string description: Specifies the AzureBareMetal instance unique ID. powerState: readOnly: true type: string enum: - starting - started - stopping - stopped - restarting - unknown x-ms-enum: name: AzureBareMetalInstancePowerStateEnum modelAsString: true description: Resource power state proximityPlacementGroup: readOnly: true type: string description: Resource proximity placement group hwRevision: readOnly: true type: string description: Hardware revision of an AzureBareMetal instance partnerNodeId: type: string description: ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance provisioningState: readOnly: true type: string enum: - Accepted - Creating - Updating - Failed - Succeeded - Deleting - Migrating x-ms-enum: name: AzureBareMetalProvisioningStatesEnum modelAsString: true description: State of provisioning of the AzureBareMetalInstance description: Describes the properties of an AzureBareMetal instance. PolicyEvaluationResult: description: The result of a non-compliant policy evaluation against the given resource content. properties: policyInfo: description: The details of the policy that was evaluated. $ref: '#/definitions/PolicyReference' readOnly: true evaluationResult: description: The result of the policy evaluation against the resource. This will typically be 'NonCompliant' but may contain other values if errors were encountered. type: string readOnly: true evaluationDetails: description: The detailed results of the policy expressions and values that were evaluated. $ref: ../../stable/2019-10-01/policyStates.json#/definitions/PolicyEvaluationDetails readOnly: true RoutingIntentProperties: properties: routingPolicies: type: array description: List of routing policies. readOnly: false items: $ref: '#/definitions/RoutingPolicy' provisioningState: $ref: ./network.json#/definitions/ProvisioningState readOnly: true description: The provisioning state of the RoutingIntent resource. description: The properties of a RoutingIntent resource. type: object VpnClientConnectionHealth: properties: totalIngressBytesTransferred: readOnly: true type: integer format: int64 description: Total of the Ingress Bytes Transferred in this P2S Vpn connection. totalEgressBytesTransferred: readOnly: true type: integer format: int64 description: Total of the Egress Bytes Transferred in this connection. vpnClientConnectionsCount: type: integer format: int32 description: The total of p2s vpn clients connected at this time to this P2SVpnGateway. allocatedIpAddresses: type: array items: type: string description: List of allocated ip addresses to the connected p2s vpn clients. description: VpnClientConnectionHealth properties. HybridComputePrivateLinkScopeProperties: type: object description: Properties that define a Azure Arc PrivateLinkScope resource. properties: publicNetworkAccess: description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. $ref: '#/definitions/PublicNetworkAccessType_2' provisioningState: type: string description: 'Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.' readOnly: true privateLinkScopeId: readOnly: true description: The Guid id of the private link scope. type: string privateEndpointConnections: readOnly: true description: The collection of associated Private Endpoint Connections. type: array items: $ref: '#/definitions/PrivateEndpointConnectionDataModel' KubernetesConfigurationPrivateLinkScope: type: object properties: properties: description: Properties that define a Azure Arc PrivateLinkScope resource. $ref: '#/definitions/KubernetesConfigurationPrivateLinkScopeProperties' allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource description: An Azure Arc PrivateLinkScope definition. ApiEndpoint: description: The properties for a Media Services REST API endpoint. example: endpoint: https://wamsbayclus001rest-hs.cloudapp.net/api/ majorVersion: '2' properties: endpoint: description: The Media Services REST endpoint. type: string majorVersion: description: The version of Media Services REST API. type: string Action: properties: type: $ref: '#/definitions/RouteMapActionType' description: Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.' parameters: type: array description: List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added items: $ref: '#/definitions/Parameter' x-ms-identifiers: [] description: Action to be taken on a route matching a RouteMap criterion. type: object UserAssignedIdentitiesListResult: properties: value: type: array items: $ref: '#/definitions/Identity_2' 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. UserAssignedManagedIdentities: type: object description: The User Assigned Managed Identities. additionalProperties: $ref: '#/definitions/UserAssignedManagedIdentity' KubernetesClusterRestartNodeParameters: type: object title: KubernetesClusterRestartNodeParameters represents the body of the request to restart the node of a Kubernetes cluster. required: - nodeName properties: nodeName: description: The name of the node to restart. type: string AzureDevOpsOrgProperties: description: AzureDevOps Org properties. type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState_3' autoDiscovery: $ref: '#/definitions/AutoDiscovery' WorkspaceResourceProperties: description: Properties of a Workspace properties: providers: type: array description: List of Providers selected for this Workspace items: $ref: '#/definitions/Provider' x-ms-identifiers: [] usable: type: string enum: - 'Yes' - 'No' - Partial x-ms-enum: name: UsableStatus modelAsString: true description: Whether the current workspace is ready to accept Jobs. readOnly: true provisioningState: type: string enum: - Succeeded - ProviderLaunching - ProviderUpdating - ProviderDeleting - ProviderProvisioning - Failed x-ms-enum: name: ProvisioningStatus modelAsString: true description: Provisioning status field readOnly: true storageAccount: type: string description: ARM Resource Id of the storage account associated with this workspace. endpointUri: type: string description: The URI of the workspace endpoint. readOnly: true LogAnalyticsQueryPackProperties: description: Properties that define a Log Analytics QueryPack resource. properties: queryPackId: type: string description: The unique ID of your application. This field cannot be changed. readOnly: true timeCreated: type: string readOnly: true description: Creation Date for the Log Analytics QueryPack, in ISO 8601 format. format: date-time timeModified: type: string readOnly: true description: Last modified date of the Log Analytics QueryPack, in ISO 8601 format. format: date-time provisioningState: type: string description: 'Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.' readOnly: true CloudErrorBody_2: type: object x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. 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_2' x-ms-identifiers: - message - target description: A list of additional details about the error. description: An error response from the Batch service. ThreePartVersionPattern: type: string description: Version with three part. example: 1.0.4 pattern: ^(0|[1-9][0-9]{0,18})\.(0|[1-9][0-9]{0,18})\.(0|[1-9][0-9]{0,18})$ ClusterPrometheusProfile: type: object description: Cluster Prometheus profile. required: - enabled properties: enabled: type: boolean description: Enable Prometheus for cluster or not. default: false KubernetesClusterNode: type: object title: KubernetesClusterNode represents the details of a node in a Kubernetes cluster. properties: agentPoolId: description: The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.NetworkCloud/kubernetesClusters/agentPools readOnly: true availabilityZone: description: The availability zone this node is running within. type: string readOnly: true bareMetalMachineId: description: The resource ID of the bare metal machine that hosts this node. type: string format: arm-id readOnly: true cpuCores: description: The number of CPU cores configured for this node, derived from the VM SKU specified. type: integer format: int64 readOnly: true detailedStatus: description: The detailed state of this node. type: string enum: - Available - Error - Provisioning - Running - Scheduling - Stopped - Terminating - Unknown x-ms-enum: modelAsString: true name: KubernetesClusterNodeDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true diskSizeGB: description: The size of the disk configured for this node. type: integer format: int64 readOnly: true image: description: The machine image used to deploy this node. type: string readOnly: true kubernetesVersion: description: The currently running version of Kubernetes and bundled features running on this node. type: string readOnly: true labels: description: The list of labels on this node that have been assigned to the agent pool containing this node. type: array items: $ref: '#/definitions/KubernetesLabel' x-ms-identifiers: - key readOnly: true memorySizeGB: description: The amount of memory configured for this node, derived from the vm SKU specified. type: integer format: int64 readOnly: true mode: description: The mode of the agent pool containing this node. Not applicable for control plane nodes. type: string enum: - System - User - NotApplicable x-ms-enum: modelAsString: true name: AgentPoolMode readOnly: true name: description: The name of this node, as realized in the Kubernetes cluster. type: string readOnly: true networkAttachments: description: The NetworkAttachments made to this node. type: array items: $ref: '#/definitions/NetworkAttachment' x-ms-identifiers: - networkAttachmentName readOnly: true powerState: description: The power state of this node. type: string enum: - 'On' - 'Off' - Unknown x-ms-enum: modelAsString: true name: KubernetesNodePowerState readOnly: true role: description: The role of this node in the cluster. type: string enum: - ControlPlane - Worker x-ms-enum: modelAsString: true name: KubernetesNodeRole readOnly: true taints: description: The list of taints that have been assigned to the agent pool containing this node. type: array items: $ref: '#/definitions/KubernetesLabel' x-ms-identifiers: - key readOnly: true vmSkuName: description: The VM SKU name that was used to create this cluster node. type: string readOnly: true ValidationResponseProperties: description: Properties of pre job creation validation response. type: object properties: status: description: Overall validation status. enum: - AllValidToProceed - InputsRevisitRequired - CertainInputValidationsSkipped type: string readOnly: true x-ms-enum: name: OverallValidationStatus modelAsExtensible: true values: - value: AllValidToProceed description: Every input request is valid. - value: InputsRevisitRequired description: Some input requests are not valid. - value: CertainInputValidationsSkipped description: Certain input validations skipped. individualResponseDetails: description: List of response details contain validationType and its response as key and value respectively. type: array items: $ref: '#/definitions/ValidationInputResponse' readOnly: true BareMetalMachineRunReadCommandsParameters: type: object title: BareMetalMachineRunReadCommandsParameters represents the body of request containing list of read-only commands to run on the bare metal machine. required: - commands - limitTimeSeconds properties: commands: description: The list of read-only commands to be executed directly against the target machine. type: array minItems: 1 items: $ref: '#/definitions/BareMetalMachineCommandSpecification' x-ms-identifiers: [] limitTimeSeconds: description: 'The maximum time the commands are allowed to run. If the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).' type: integer format: int64 maximum: 14400 minimum: 60 ContainerGroupSku: description: The container group SKU. type: string enum: - Standard - Dedicated x-ms-enum: name: ContainerGroupSku modelAsString: true PrivateLinkScopedResource: properties: ResourceId: type: string description: The full resource Id of the private link scope resource. ScopeId: type: string description: The private link scope unique Identifier. description: The private link scope resource reference. HubVirtualNetworkConnection: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/HubVirtualNetworkConnectionProperties' description: Properties of the hub virtual network connection. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. allOf: - $ref: ./network.json#/definitions/SubResource description: HubVirtualNetworkConnection Resource. DaprProperties: type: object description: Indicates some additional properties for dapr client type properties: version: x-nullable: true type: string description: The dapr component version componentType: x-nullable: true type: string description: The dapr component type secretStoreComponent: x-nullable: true type: string description: The name of a secret store dapr to retrieve secret metadata: description: Additional dapr metadata type: array items: $ref: '#/definitions/DaprMetadata' x-ms-identifiers: - name scopes: description: The dapr component scopes type: array items: type: string runtimeVersion: x-nullable: true type: string readOnly: true description: The runtime version supported by the properties bindingComponentDirection: x-nullable: true type: string enum: - input - output x-ms-enum: name: DaprBindingComponentDirection modelAsString: true readOnly: true description: The direction supported by the dapr binding component ValidationThreshold: type: object title: ValidationThreshold indicates allowed machine and node hardware and deployment failures. required: - type - grouping - value properties: grouping: description: Selection of how the type evaluation is applied to the cluster calculation. type: string enum: - PerCluster - PerRack x-ms-enum: modelAsString: true name: ValidationThresholdGrouping type: description: Selection of how the threshold should be evaluated. type: string enum: - CountSuccess - PercentSuccess x-ms-enum: modelAsString: true name: ValidationThresholdType value: description: The numeric threshold value. type: integer format: int64 minimum: 0 TrunkedNetworkList: type: object title: TrunkedNetworkList represents a list of trunked networks. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of trunked networks. type: array items: $ref: '#/definitions/TrunkedNetwork' WorkspaceListResult: properties: value: type: array items: $ref: '#/definitions/QuantumWorkspace' description: Result of a list Workspaces operation. nextLink: type: string description: Link to the next set of results. Not empty if Value contains incomplete list of Workspaces. description: The response of a list Workspaces operation. ApplicationHealthReportList: description: List of the application health reports. properties: value: type: array description: A report of the health status of an identity applications. items: $ref: '#/definitions/ApplicationHealthReport' x-ms-identifiers: [] nextLink: description: URI to the next page. type: string DnsResourceReferenceResultProperties: type: object properties: dnsResourceReferences: type: array x-ms-identifiers: [] items: $ref: '#/definitions/DnsResourceReference' description: The result of dns resource reference request. A list of dns resource references for each of the azure resource in the request description: The result of dns resource reference request. Returns a list of dns resource references for each of the azure resource in the request. CassandraClusterPublicStatus: type: object description: Properties of a managed Cassandra cluster public status. properties: eTag: type: string reaperStatus: $ref: '#/definitions/ManagedCassandraReaperStatus' connectionErrors: type: array description: List relevant information about any connection errors to the Datacenters. items: $ref: '#/definitions/ConnectionError' errors: type: array description: List relevant information about any errors about cluster, data center and connection error. items: $ref: '#/definitions/CassandraError' dataCenters: type: array description: List of the status of each datacenter in this cluster. items: type: object properties: name: type: string description: The name of this Datacenter. seedNodes: type: array description: A list of all seed nodes in the cluster, managed and unmanaged. items: type: string nodes: type: array items: type: object properties: address: type: string description: The node's IP address. state: $ref: '#/definitions/ManagedCassandraNodeState' status: type: string cassandraProcessStatus: type: string description: Cassandra service status on this node load: type: string description: The amount of file system data in the data directory (e.g., 47.66 kB), excluding all content in the snapshots subdirectories. Because all SSTable data files are included, any data that is not cleaned up (such as TTL-expired cells or tombstones) is counted. tokens: type: array description: List of tokens this node covers. items: type: string size: type: integer format: int32 hostID: description: The network ID of the node. type: string rack: description: The rack this node is part of. type: string timestamp: description: The timestamp when these statistics were captured. type: string diskUsedKB: description: The amount of disk used, in kB, of the directory /var/lib/cassandra. type: integer format: int64 diskFreeKB: description: The amount of disk free, in kB, of the directory /var/lib/cassandra. type: integer format: int64 memoryUsedKB: description: Used memory (calculated as total - free - buffers - cache), in kB. type: integer format: int64 memoryBuffersAndCachedKB: description: Memory used by kernel buffers (Buffers in /proc/meminfo) and page cache and slabs (Cached and SReclaimable in /proc/meminfo), in kB. type: integer format: int64 memoryFreeKB: description: Unused memory (MemFree and SwapFree in /proc/meminfo), in kB. type: integer format: int64 memoryTotalKB: description: Total installed memory (MemTotal and SwapTotal in /proc/meminfo), in kB. type: integer format: int64 cpuUsage: description: A float representing the current system-wide CPU utilization as a percentage. type: number format: double isLatestModel: type: boolean description: If node has been updated to latest model AutoscaleProfile: type: object description: This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale. required: - enabled properties: enabled: type: boolean description: This indicates whether auto scale is enabled on HDInsight on AKS cluster. gracefulDecommissionTimeout: type: integer format: int32 description: This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout. autoscaleType: type: string description: User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. enum: - ScheduleBased - LoadBased x-ms-enum: name: AutoscaleType modelAsString: true scheduleBasedConfig: description: Profiles of schedule based Autoscale. $ref: '#/definitions/ScheduleBasedConfig' loadBasedConfig: description: Profiles of load based Autoscale. $ref: '#/definitions/LoadBasedConfig' AssociatedResourcesListResult: type: object properties: totalCount: type: number readOnly: true description: Total number of Azure resources assigned to the identity. value: type: array readOnly: true items: $ref: '#/definitions/AzureResource_3' description: The collection of Azure resources returned by the resource action to get a list of assigned resources. nextLink: type: string readOnly: true description: The url to get the next page of results, if any. description: Azure resources returned by the resource action to get a list of assigned resources. eventsAiInfo: description: AI related application info for an event result type: object properties: iKey: description: iKey of the app type: string appName: description: Name of the application type: string appId: description: ID of the application type: string sdkVersion: description: SDK version of the application type: string CostEstimate: type: object description: The job cost billed by the provider. The final cost on your bill might be slightly different due to added taxes and currency conversion rates. properties: currencyCode: type: string description: The currency code. events: type: array description: List of usage events. items: $ref: '#/definitions/UsageEvent' x-ms-identifiers: [] estimatedTotal: type: number format: float description: The estimated total. required: - currencyCode - estimatedTotal pendingFlowsListResult: type: object properties: value: type: array items: $ref: '#/definitions/pendingFlow' description: flows array. x-ms-identifiers: - id nextLink: description: Link to next results type: string description: The connections list result. virtualNetworks: type: object x-ms-azure-resource: true properties: properties: $ref: '#/definitions/virtualNetworksProperties' systemData: readOnly: true $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData extendedLocation: type: object properties: type: type: string description: The extended location type. name: type: string description: The extended location name. allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource description: The virtualNetworks resource definition. ErrorResponse_8: description: Error response indicates Microsoft.MarketplaceOrdering service is not able to process the incoming request. The reason is provided in the error message. type: object properties: error: description: The details of the error. properties: code: description: Error code. type: string readOnly: true message: description: Error message indicating why the operation failed. type: string readOnly: true MachineDisk: type: object title: Disk represents the properties of the disk. properties: capacityGB: description: The maximum amount of storage in GB. type: integer format: int64 readOnly: true connection: description: The connection type of the rack SKU resource. type: string enum: - PCIE - SATA - RAID - SAS x-ms-enum: modelAsString: true name: MachineSkuDiskConnectionType readOnly: true type: description: The disk type of rack SKU resource. type: string enum: - HDD - SSD x-ms-enum: modelAsString: true name: DiskType readOnly: true CheckNameAvailabilityResponse: description: The check name availability response definition type: object properties: nameAvailable: description: A value indicating whether the name is available. type: boolean reason: description: The reason for the unavailability of the name. $ref: '#/definitions/NameUnavailabilityReason' message: description: The message explaining the reason. type: string ListVirtualHubBgpConnectionResults: properties: value: type: array items: $ref: '#/definitions/BgpConnection' description: The list of VirtualHubBgpConnections. nextLink: type: string description: URL to get the next set of results. description: VirtualHubBgpConnections list. Cluster_2: type: object title: Cluster represents the on-premises Network Cloud cluster. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster manager associated with the cluster. properties: $ref: '#/definitions/ClusterProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true ClusterManagerList: type: object title: ClusterManagerList represents a list of cluster manager objects. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of cluster managers. type: array items: $ref: '#/definitions/ClusterManager' PerformanceCounterConfiguration: type: object required: - name - samplingPeriod properties: name: type: string samplingPeriod: type: string instance: type: string Identity_4: properties: principalId: readOnly: true type: string description: The principal ID of the system-assigned identity of the search service. tenantId: readOnly: true type: string description: The tenant ID of the system-assigned identity of the search service. type: type: string description: The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service. enum: - None - SystemAssigned - UserAssigned - SystemAssigned, UserAssigned x-ms-enum: name: IdentityType modelAsString: true values: - value: None name: None description: Indicates that any identity associated with the search service needs to be removed. - value: SystemAssigned name: SystemAssigned description: Indicates that system-assigned identity for the search service will be enabled. - value: UserAssigned name: UserAssigned description: Indicates that one or more user assigned identities will be assigned to the search service. - value: SystemAssigned, UserAssigned name: SystemAssigned, UserAssigned description: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. userAssignedIdentities: $ref: '#/definitions/UserAssignedManagedIdentities_2' description: 'The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''.' required: - type description: Details about the search service identity. A null value indicates that the search service has no identity assigned. HealthMonitorStateChangeProperties: description: Properties of the monitor. type: object properties: monitorName: description: Human-readable name of the monitor. type: string example: 'logical-disks|C:' monitorType: description: Type of the monitor. type: string example: logical-disks|* monitoredObject: description: Dynamic monitored object of the monitor. type: string example: 'C:' evaluationTimestamp: description: Timestamp of the monitor's last health evaluation. type: string example: '2020-01-08T20:20:18.5765757Z' currentStateFirstObservedTimestamp: description: Timestamp of the monitor's last health state change. type: string example: '2020-01-08T20:20:18.5765757Z' previousMonitorState: description: Previous health state of the monitor. $ref: '#/definitions/HealthState_3' example: Healthy currentMonitorState: description: Current health state of the monitor. $ref: '#/definitions/HealthState_3' example: Critical evidence: description: Evidence validating the monitor's current health state. type: object monitorConfiguration: description: The configuration settings at the time of the monitor's health evaluation. type: object ClusterScanRuntimeParameters: type: object title: ClusterScanRuntimeParameters defines the parameters for the cluster scan runtime operation. properties: scanActivity: description: The choice of if the scan operation should run the scan. type: string default: Scan enum: - Scan - Skip x-ms-enum: modelAsString: true name: ClusterScanRuntimeParametersScanActivity RemotePrivateEndpoint: description: Remote private endpoint details. type: object properties: id: description: Remote endpoint resource ID. type: string location: description: ARM location of the remote private endpoint. type: string immutableSubscriptionId: description: Original subscription ID needed by Microsoft.Network. type: string immutableResourceId: description: Original resource ID needed by Microsoft.Network. type: string vnetTrafficTag: description: Virtual network traffic tag. type: string manualPrivateLinkServiceConnections: description: List of private link service connections that need manual approval. type: array items: $ref: '#/definitions/PrivateLinkServiceConnection' privateLinkServiceConnections: description: List of automatically approved private link service connections. type: array items: $ref: '#/definitions/PrivateLinkServiceConnection' privateLinkServiceProxies: description: List of private link service proxies. type: array items: $ref: '#/definitions/PrivateLinkServiceProxy' connectionDetails: description: List of connection details. type: array items: $ref: '#/definitions/ConnectionDetails' AlertRuleProperties: description: An Azure Activity Log Alert rule. type: object properties: tenantScope: description: The tenant GUID. Must be provided for tenant-level and management group events rules. type: string scopes: description: A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item. type: array items: type: string condition: description: The condition that will cause this alert to activate. $ref: '#/definitions/AlertRuleAllOfCondition' actions: description: The actions that will activate when the condition is met. $ref: '#/definitions/ActionList' enabled: description: Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. type: boolean default: true description: description: A description of this Activity Log Alert rule. type: string required: - condition - actions SyncStorageKeysInput: description: The request body for a SyncStorageKeys API. example: id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia required: - id properties: id: description: The id of the storage account resource. type: string SparkProfile: type: object description: The spark cluster profile. properties: defaultStorageUrl: type: string description: The default storage URL. metastoreSpec: $ref: '#/definitions/SparkMetastoreSpec' userPluginsSpec: $ref: '#/definitions/SparkUserPlugins' ManagedCassandraARMResourceProperties: type: object description: The core properties of ARM resources. properties: id: readOnly: true type: string description: The unique resource identifier of the ARM resource. name: readOnly: true type: string description: The name of the ARM resource. type: readOnly: true type: string description: The type of Azure resource. location: type: string description: The location of the resource group to which the resource belongs. tags: $ref: cosmos-db.json#/definitions/Tags identity: $ref: '#/definitions/ManagedCassandraManagedServiceIdentity' x-ms-azure-resource: true ListPathsResponse: properties: streamingPaths: type: array items: $ref: '#/definitions/StreamingPath' description: Streaming Paths supported by current Streaming Locator downloadPaths: type: array items: type: string description: Download Paths supported by current Streaming Locator type: object description: Class of response for listPaths action ContainerExecResponse: description: The information for the container exec command. type: object properties: webSocketUri: type: string description: The uri for the exec websocket. password: type: string description: The password to start the exec command. x-ms-secret: true ThroughputPoolUpdate: type: object description: Represents a throughput pool resource for updates. properties: properties: $ref: '#/definitions/ThroughputPoolProperties' x-ms-client-flatten: true description: Properties of the throughput pool. Project: type: object x-ms-azure-resource: true description: Azure Migrate Project. properties: id: type: string description: Path reference to this project /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName} readOnly: true name: type: string description: Name of the project. readOnly: true type: type: string description: Type of the object = [Microsoft.Migrate/projects]. readOnly: true eTag: type: string description: For optimistic concurrency control. location: type: string description: Azure location in which project is created. tags: type: object description: Tags provided by Azure Tagging service. properties: description: Properties of the project. x-ms-client-flatten: true $ref: '#/definitions/ProjectProperties' ContainerProperties: description: The container instance properties. type: object required: - image - resources properties: image: description: The name of the image used to create the container instance. type: string command: description: The commands to execute within the container instance in exec form. type: array items: type: string ports: description: The exposed ports on the container instance. type: array items: $ref: '#/definitions/ContainerPort' x-ms-identifiers: - port environmentVariables: description: The environment variables to set in the container instance. type: array items: $ref: '#/definitions/EnvironmentVariable' x-ms-identifiers: - name instanceView: description: The instance view of the container instance. Only valid in response. readOnly: true type: object properties: restartCount: readOnly: true type: integer format: int32 description: The number of times that the container instance has been restarted. currentState: readOnly: true description: Current container instance state. $ref: '#/definitions/ContainerState' previousState: readOnly: true description: Previous container instance state. $ref: '#/definitions/ContainerState' events: readOnly: true description: The events of the container instance. type: array items: $ref: '#/definitions/Event' x-ms-identifiers: - name - type resources: description: The resource requirements of the container instance. $ref: '#/definitions/ResourceRequirements' volumeMounts: description: The volume mounts available to the container instance. type: array items: $ref: '#/definitions/VolumeMount' x-ms-identifiers: - name livenessProbe: description: The liveness probe. $ref: '#/definitions/ContainerProbe' readinessProbe: description: The readiness probe. $ref: '#/definitions/ContainerProbe' securityContext: description: The container security properties. $ref: '#/definitions/SecurityContextDefinition' VirtualMachinePatchProperties: type: object title: VirtualMachinePatchProperties represents the properties of the virtual machine that can be patched. properties: vmImageRepositoryCredentials: $ref: '#/definitions/ImageRepositoryCredentials' description: The credentials used to login to the image repository that has access to the specified image. GeoRegion: description: Geographical region. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: GeoRegion resource specific properties type: object properties: description: description: Region description. type: string readOnly: true displayName: description: Display name for region. type: string readOnly: true orgDomain: description: Display name for region. type: string readOnly: true x-ms-client-flatten: true TrinoProfile: type: object description: Trino Cluster profile. properties: catalogOptions: $ref: '#/definitions/CatalogOptions' coordinator: $ref: '#/definitions/TrinoCoordinator' userPluginsSpec: $ref: '#/definitions/TrinoUserPlugins' userTelemetrySpec: $ref: '#/definitions/TrinoUserTelemetry' worker: $ref: '#/definitions/TrinoWorker' PrivateEndpointProperty: type: object description: Private endpoint which the connection belongs to. properties: id: description: Resource id of the private endpoint. type: string ListRouteMapsResult: description: List of RouteMaps and a URL nextLink to get the next set of results. type: object properties: value: type: array items: $ref: '#/definitions/RouteMap' description: List of RouteMaps. nextLink: type: string description: URL to get the next set of operation list results if there are any. ApplicationHealthReport: description: A report of the health status of an identity applications. type: object properties: appId: description: The application identifier. type: string servicePrincipalObjectId: description: The service principal identifier. type: string status: description: The roll-up health status for the application $ref: '#/definitions/HealthStatus' appRoleAssignments: description: List of AppRoleAssignment health reports for the application. $ref: '#/definitions/AppRoleAssignmentHealthReportList' oAuth2PermissionGrants: description: List of OAuth2PermissionGrant health reports for the application. $ref: '#/definitions/OAuth2PermissionGrantHealthReportList' servicePrincipalTags: description: List of ServicePrincipalTag health reports for the application. $ref: '#/definitions/ServicePrincipalTagHealthReportList' QuantumComputingData: type: object description: Quantum computing data. properties: count: type: integer format: int64 description: The number of quantum computing items in the job. readOnly: true required: - count EndpointAuthentication: description: Service endpoints authentication details. type: object properties: aadTenantID: description: AAD tenant ID. type: string principalID: description: AAD principal ID. type: string principalType: description: AAD principal type. type: string enum: - Application - User x-ms-enum: name: principalType modelAsString: true LogAnalytics: description: Container group log analytics information. type: object properties: workspaceId: description: The workspace id for log analytics type: string workspaceKey: description: The workspace key for log analytics type: string x-ms-secret: true logType: type: string description: The log type to be used. enum: - ContainerInsights - ContainerInstanceLogs x-ms-enum: name: LogAnalyticsLogType modelAsString: true metadata: type: object description: Metadata for log analytics. additionalProperties: type: string workspaceResourceId: description: The workspace resource id for log analytics type: string x-ms-secret: true required: - workspaceId - workspaceKey eventsClientInfo: description: Client info for an event result type: object properties: model: description: Model of the client type: string os: description: Operating system of the client type: string type: description: Type of the client type: string browser: description: Browser of the client type: string ip: description: IP address of the client type: string city: description: City of the client type: string stateOrProvince: description: State or province of the client type: string countryOrRegion: description: Country or region of the client type: string ClusterJob: description: Cluster job. type: object allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource required: - properties properties: properties: $ref: '#/definitions/ClusterJobProperties' AlertRuleList: type: object description: A list of Activity Log Alert rules. properties: value: description: The list of Activity Log Alert rules. type: array items: $ref: '#/definitions/ActivityLogAlertResource' x-ms-identifiers: - id nextLink: description: Provides the link to retrieve the next set of elements. type: string RackPatchParameters: type: object title: RackPatchParameters represents the body of the request to patch the rack properties. properties: properties: $ref: '#/definitions/RacksPatchProperties' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string SystemData_2: description: Metadata pertaining to creation and last modification of the resource. type: object properties: createdBy: description: The identity that created the resource. type: string createdByType: description: The type of identity that created the resource. enum: - User - Application - ManagedIdentity - Key type: string x-ms-enum: name: createdByType modelAsString: true createdAt: format: date-time description: The timestamp of resource creation (UTC). type: string lastModifiedBy: description: The identity that last modified the resource. type: string lastModifiedByType: description: The type of identity that last modified the resource. enum: - User - Application - ManagedIdentity - Key type: string x-ms-enum: name: lastModifiedByType modelAsString: true lastModifiedAt: format: date-time description: The timestamp of resource modification (UTC). type: string readOnly: true CloudHsmClusterProperties: properties: provisioningState: type: string description: The Cloud HSM Cluster's provisioningState enum: - Provisioning - Succeeded - Failed - Deleting - Canceled x-ms-enum: name: ProvisioningState modelAsString: true autoGeneratedDomainNameLabelScope: type: string description: The Cloud HSM Cluster's auto-generated Domain Name Label Scope securityDomain: $ref: '#/definitions/CloudHsmClusterSecurityDomainProperties' hsms: type: array description: An array of Cloud HSM Cluster's HSMs x-ms-identifiers: - fqdn items: $ref: '#/definitions/CloudHsmProperties' publicNetworkAccess: type: string description: The Cloud HSM Cluster public network access privateEndpointConnections: type: array description: List of private endpoint connection resources x-ms-identifiers: - name items: $ref: '#/definitions/PrivateEndpointConnection' statusMessage: type: string description: Cloud HSM Cluster status message readOnly: true restoreProperties: $ref: '#/definitions/RestoreProperties' backupProperties: $ref: '#/definitions/BackupProperties' description: Properties of a Cloud HSM Cluster. type: object unlinkLogAnalyticsResponseProperties: type: object description: Properties for unlinking log analytics properties: status: description: Status of the unlink operation type: string ImageRegistryCredential: description: Image registry credential. type: object properties: server: type: string description: The Docker image registry server without a protocol such as "http" and "https". username: type: string description: The username for the private registry. password: type: string description: The password for the private registry. x-ms-secret: true identity: type: string description: The identity for the private registry. identityUrl: type: string description: The identity URL for the private registry. required: - server JobDetails: type: object description: A job to be run in the workspace. properties: id: $ref: '#/definitions/WorkspaceItemId' description: Id of the job. readOnly: true jobType: $ref: '#/definitions/JobType' description: The type of job. x-ms-mutability: - read - create sessionId: type: string description: The ID of the session that the job is part of. x-ms-mutability: - read - create containerUri: type: string description: The blob container SAS uri, the container is used to host job data. x-ms-mutability: - read - create inputDataUri: type: string description: The input blob URI, if specified, it will override the default input blob in the container. x-ms-mutability: - read - create inputDataFormat: type: string description: The format of the input data. x-ms-mutability: - read - create status: $ref: '#/definitions/JobStatus' description: The status of the job. readOnly: true metadata: type: object description: The job metadata. Metadata provides client the ability to store client-specific information x-ms-mutability: - read - update - create cancellationTime: type: string format: date-time description: The time when a job was successfully cancelled. readOnly: true tags: type: array description: List of user-supplied tags associated with the job. items: type: string x-ms-mutability: - read - update - create quantumComputingData: $ref: '#/definitions/QuantumComputingData' description: Quantum computing data. readOnly: true inputParams: type: object description: The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data. x-ms-mutability: - read - create outputDataUri: type: string description: The output blob uri. When a job finishes successfully, results will be uploaded to this blob. x-ms-mutability: - read - create outputDataFormat: type: string description: The format of the output data. x-ms-mutability: - read - create required: - id - containerUri allOf: - $ref: '#/definitions/ItemDetails' x-ms-discriminator-value: Job VideoProperties: properties: title: type: string description: Optional video title provided by the user. Value can be up to 256 characters long. description: type: string description: Optional video description provided by the user. Value can be up to 2048 characters long. type: type: string enum: - Archive - File x-ms-enum: name: VideoType values: - value: Archive description: Archive is flexible format that represents a video stream associated with wall-clock time. The video archive can either be continuous or discontinuous. An archive is discontinuous when there are gaps in the recording due to various reasons, such as the live pipeline being stopped, camera being disconnected or due to the use of event based recordings through the use of a signal gate. There is no limit to the archive duration and new video data can be appended to the existing archive at any time, as long as the same video codec and codec parameters are being used. Videos of this type are suitable for appending and long term archival. - value: File description: File represents a video which is stored as a single media file, such as MP4. Videos of this type are suitable to be downloaded for external consumption. modelAsString: true description: Video content type. Different content types are suitable for different applications and scenarios. readOnly: true x-nullable: false flags: $ref: '#/definitions/VideoFlags' description: Video flags contain information about the available video actions and its dynamic properties based on the current video state. readOnly: true contentUrls: $ref: '#/definitions/VideoContentUrls' description: Set of URLs to the video content. readOnly: true mediaInfo: $ref: '#/definitions/VideoMediaInfo' description: Contains information about the video and audio content. archival: $ref: '#/definitions/VideoArchival' description: Video archival properties. type: object description: Application level properties for the video resource. AddressValidationOutput: description: Output of the address validation api. type: object properties: properties: $ref: '#/definitions/AddressValidationProperties' description: The address validation properties. readOnly: true x-ms-client-flatten: true ComponentLinkedStorageAccounts: description: An Application Insights component linked storage accounts type: object allOf: - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/LinkedStorageAccountsProperties' description: The properties of the linked storage accounts. x-ms-client-flatten: true HybridConnectionConfig: type: object description: Contains the REP (rendezvous endpoint) and “Sender” access token. properties: expirationTime: description: Timestamp when this token will be expired. type: integer readOnly: true format: int64 hybridConnectionName: description: Name of the connection type: string readOnly: true relay: description: Name of the relay. type: string readOnly: true token: description: Sender access token type: string readOnly: true ErrorResponse_9: type: object description: Describes the format of Error response. properties: error: description: The error object properties: code: type: string description: Error code message: type: string description: Error message indicating why the operation failed. StorageAppliancePatchProperties: type: object title: StorageAppliancePatchProperties represents the properties of the storage appliance that can be patched. properties: serialNumber: description: The serial number for the storage appliance. type: string ActionGroup: description: An Azure action group. type: object properties: groupShortName: type: string maxLength: 12 description: The short name of the action group. This will be used in SMS messages. enabled: type: boolean default: true description: Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. emailReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/EmailReceiver' description: The list of email receivers that are part of this action group. smsReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/SmsReceiver' description: The list of SMS receivers that are part of this action group. webhookReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/WebhookReceiver' description: The list of webhook receivers that are part of this action group. itsmReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/ItsmReceiver' description: The list of ITSM receivers that are part of this action group. azureAppPushReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/AzureAppPushReceiver' description: The list of AzureAppPush receivers that are part of this action group. automationRunbookReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/AutomationRunbookReceiver' description: The list of AutomationRunbook receivers that are part of this action group. voiceReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/VoiceReceiver' description: The list of voice receivers that are part of this action group. logicAppReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/LogicAppReceiver' description: The list of logic app receivers that are part of this action group. azureFunctionReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/AzureFunctionReceiver' description: The list of azure function receivers that are part of this action group. armRoleReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/ArmRoleReceiver' description: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported. eventHubReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/EventHubReceiver' description: The list of event hub receivers that are part of this action group. required: - groupShortName - enabled ComputeResourceDefinition: type: object description: The cpu and memory requirement definition. required: - cpu - memory properties: cpu: type: number format: float description: The required CPU. memory: type: integer format: int64 description: The required memory in MB, Container memory will be 110 percentile ResourceNameAvailability: description: Information regarding availability of a resource name. type: object properties: nameAvailable: description: true indicates name is valid and available. false indicates the name is invalid, unavailable, or both. type: boolean reason: description: Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. enum: - Invalid - AlreadyExists type: string x-ms-enum: name: InAvailabilityReasonType modelAsString: true message: description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name. type: string JobStatus: type: string description: The status of the job. enum: - Waiting - Executing - Succeeded - Failed - Cancelled x-ms-enum: name: JobStatus modelAsString: true values: - name: Waiting value: Waiting description: The job is waiting in the queue to be executed. - name: Executing value: Executing description: The job is being executed. - name: Succeeded value: Succeeded description: The job completed with success. - name: Failed value: Failed description: The job completed with failure. - name: Cancelled value: Cancelled description: The job was cancelled. GitHubRepoProperties: description: GitHub Repo properties. type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState_3' accountId: format: int64 description: Gets or sets gitHub repo account id. type: integer repoUrl: description: Gets or sets gitHub repo url. type: string ownerName: description: Gets or sets GitHub Owner Name. type: string ClusterPatchParameters: type: object title: ClusterPatchParameters represents the body of the request to patch the cluster properties. properties: properties: $ref: '#/definitions/ClusterPatchProperties_2' description: The list of the resource properties. x-ms-client-flatten: true tags: description: The Azure resource tags that will replace the existing ones. type: object additionalProperties: type: string virtualNetworksListResult: type: object properties: value: type: array items: $ref: '#/definitions/virtualNetworks' nextLink: type: string x-ms-identifiers: [] ListVpnGatewayNatRulesResult: description: Result of the request to list all nat rules to a virtual wan vpn gateway. It contains a list of Nat rules and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnGatewayNatRule' description: List of Nat Rules. nextLink: type: string description: URL to get the next set of operation list results if there are any. Criterion: properties: routePrefix: type: array description: List of route prefixes which this criteria matches. items: type: string community: type: array description: List of BGP communities which this criteria matches. items: type: string asPath: type: array description: List of AS paths which this criteria matches. items: type: string matchCondition: $ref: '#/definitions/RouteMapMatchCondition' description: Match condition to apply RouteMap rules. description: A matching criteria which matches routes based on route prefix, community, and AS path. type: object VpnConnectionProperties: properties: remoteVpnSite: $ref: ./network.json#/definitions/SubResource description: Id of the connected vpn site. routingWeight: type: integer format: int32 description: Routing weight for vpn connection. dpdTimeoutSeconds: type: integer format: int32 description: DPD timeout in seconds for vpn connection. connectionStatus: description: The connection status. $ref: '#/definitions/VpnConnectionStatus' vpnConnectionProtocolType: description: Connection protocol used for this connection. $ref: ./virtualNetworkGateway.json#/definitions/ConnectionProtocol ingressBytesTransferred: type: integer format: int64 readOnly: true description: Ingress bytes transferred. egressBytesTransferred: type: integer format: int64 readOnly: true description: Egress bytes transferred. connectionBandwidth: type: integer format: int32 description: Expected bandwidth in MBPS. sharedKey: type: string description: SharedKey for the vpn connection. enableBgp: type: boolean description: EnableBgp flag. usePolicyBasedTrafficSelectors: type: boolean description: Enable policy-based traffic selectors. ipsecPolicies: type: array items: $ref: ./virtualNetworkGateway.json#/definitions/IpsecPolicy description: The IPSec Policies to be considered by this connection. trafficSelectorPolicies: type: array items: $ref: ./virtualNetworkGateway.json#/definitions/TrafficSelectorPolicy description: The Traffic Selector Policies to be considered by this connection. enableRateLimiting: type: boolean description: EnableBgp flag. enableInternetSecurity: type: boolean description: Enable internet security. useLocalAzureIpAddress: type: boolean description: Use local azure ip to initiate connection. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the VPN connection resource. vpnLinkConnections: type: array description: List of all vpn site link connections to the gateway. items: $ref: '#/definitions/VpnSiteLinkConnection' routingConfiguration: $ref: '#/definitions/RoutingConfiguration' description: The Routing Configuration indicating the associated and propagated route tables on this connection. description: Parameters for VpnConnection. P2SVpnGateway: required: - location properties: properties: x-ms-client-flatten: true $ref: '#/definitions/P2SVpnGatewayProperties' description: Properties of the P2SVpnGateway. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. allOf: - $ref: ./network.json#/definitions/Resource description: P2SVpnGateway Resource. L2Network: type: object title: L2Network represents a network that utilizes a single isolation domain set up for layer-2 resources. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/L2NetworkProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true AddressValidationProperties: description: The address validation output. required: - validationType type: object allOf: - $ref: '#/definitions/ValidationInputResponse' properties: validationStatus: description: The address validation status. enum: - Valid - Invalid - Ambiguous type: string readOnly: true x-ms-enum: name: AddressValidationStatus modelAsExtensible: true values: - value: Valid description: Address provided is valid. - value: Invalid description: Address provided is invalid or not supported. - value: Ambiguous description: Address provided is ambiguous, please choose one of the alternate addresses returned. alternateAddresses: description: List of alternate addresses. type: array items: $ref: '#/definitions/ShippingAddress' readOnly: true x-ms-discriminator-value: ValidateAddress GitRepoVolume: description: Represents a volume that is populated with the contents of a git repository required: - repository properties: directory: description: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. type: string repository: description: Repository URL type: string revision: description: Commit hash for the specified revision. type: string ProjectKey: type: object x-ms-azure-resource: true description: ID and Key for Migration Project. properties: workspaceId: type: string description: ID of Migration Project. readOnly: true workspaceKey: type: string description: Key of Migration Project. readOnly: true AccountPatchResource: type: object description: Account patch properties properties: {} allOf: - $ref: '#/definitions/TagUpdate' CloudError_7: x-ms-external: true properties: error: description: A list of additional details about the error. $ref: '#/definitions/CloudErrorBody_6' description: An error response from the ManagedServiceIdentity service. CloudErrorBody: x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. 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' description: A list of additional details about the error. description: An error response from the Batch service. Account: description: Device Update account details. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource properties: properties: description: Device Update account properties. x-ms-client-flatten: true type: object properties: provisioningState: description: Provisioning state. type: string enum: - Succeeded - Deleted - Failed - Canceled - Accepted - Creating readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true hostName: description: API host name. type: string readOnly: true publicNetworkAccess: description: Whether or not public network access is allowed for the account. default: Enabled enum: - Enabled - Disabled type: string x-ms-enum: name: PublicNetworkAccess modelAsString: true privateEndpointConnections: description: List of private endpoint connections associated with the account. type: array items: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection sku: description: Device Update Sku type: string enum: - Free - Standard default: Standard readOnly: false x-ms-enum: name: SKU modelAsString: true locations: description: Device Update account primary and failover location details readOnly: true x-ms-identifiers: [] type: array items: $ref: '#/definitions/Location' identity: $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity description: The type of identity used for the resource. EnabledProtocols: properties: download: type: boolean description: Enable Download protocol or not dash: type: boolean description: Enable DASH protocol or not hls: type: boolean description: Enable HLS protocol or not smoothStreaming: type: boolean description: Enable SmoothStreaming protocol or not type: object required: - download - dash - hls - smoothStreaming description: Class to specify which protocols are enabled internalMetadataProperties: type: object description: Internal metadata of the connection inside pipeline. properties: operationStatus: $ref: '#/definitions/operationStatusProperties' statusSetBy: type: string description: User that last set the approved status for this connection readOnly: true additionalProperties: {} MoveCollection: description: Define the move collection. type: object x-ms-azure-resource: true properties: id: readOnly: true type: string description: Fully qualified resource Id for the resource. name: readOnly: true type: string description: The name of the resource type: readOnly: true type: string description: The type of the resource. etag: readOnly: true type: string description: The etag of the resource. tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags. location: type: string x-ms-mutability: - read - create description: The geo-location where the resource lives. identity: $ref: '#/definitions/Identity_3' properties: $ref: '#/definitions/MoveCollectionProperties' EnvelopeEncryption: properties: enabledProtocols: $ref: '#/definitions/EnabledProtocols' description: Representing supported protocols clearTracks: type: array items: $ref: '#/definitions/TrackSelection' description: Representing which tracks should not be encrypted contentKeys: $ref: '#/definitions/StreamingPolicyContentKeys' description: Representing default content key for each encryption scheme and separate content keys for specific tracks customKeyAcquisitionUrlTemplate: type: string description: KeyAcquisitionUrlTemplate is used to point to user specified service to delivery content keys type: object description: Class for EnvelopeEncryption encryption scheme ListClusters: description: List of managed Cassandra clusters. readOnly: true type: object properties: value: description: Container for the array of clusters. type: array items: $ref: '#/definitions/ClusterResource' RemediationDeploymentSummary: properties: totalDeployments: type: integer description: The number of deployments required by the remediation. successfulDeployments: type: integer description: The number of deployments required by the remediation that have succeeded. failedDeployments: type: integer description: The number of deployments required by the remediation that have failed. description: The deployment status summary for all deployments created by the remediation. BackupResource: description: A restorable backup of a Cassandra cluster. type: object properties: backupId: description: The unique identifier of backup. type: string backupState: description: The current state of the backup. type: string enum: - Initiated - InProgress - Succeeded - Failed x-ms-enum: name: BackupState modelAsString: true backupStartTimestamp: description: The time at which the backup process begins. type: string format: date-time backupStopTimestamp: description: The time at which the backup process ends. type: string format: date-time backupExpiryTimestamp: description: The time at which the backup will expire. type: string format: date-time RackProperties: type: object title: RackProperties represents the properties of the rack. required: - rackSkuId - rackSerialNumber - availabilityZone - rackLocation properties: availabilityZone: description: The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement. type: string pattern: ^[a-zA-Z0-9]{1,10}$ clusterId: description: The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster. type: string format: arm-id readOnly: true detailedStatus: description: The more detailed status of the rack. type: string enum: - Error - Available - Provisioning x-ms-enum: modelAsString: true name: RackDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true provisioningState: description: The provisioning state of the rack resource. type: string enum: - Succeeded - Failed - Canceled - Provisioning - Accepted x-ms-enum: modelAsString: true name: RackProvisioningState readOnly: true rackLocation: description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) type: string maxLength: 256 rackSerialNumber: description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. type: string maxLength: 64 minLength: 1 rackSkuId: description: The SKU for the rack. type: string format: arm-id x-ms-arm-id-details: allowedResources: - type: Microsoft.NetworkCloud/rackSkus ClusterPoolVersionPattern: type: string description: Cluster pool version is a 2-part version. example: '1.2' pattern: ^(0|[1-9][0-9]{0,18})\.(0|[1-9][0-9]{0,18})$ RuntimeProtectionStatus: type: object title: RuntimeProtectionStatus represents the runtime protection status of the bare metal machine. properties: definitionsLastUpdated: description: The timestamp when the malware definitions were last updated. type: string format: date-time readOnly: true definitionsVersion: description: The version of the malware definitions. type: string readOnly: true scanCompletedTime: description: The timestamp of the most recently completed scan, or empty if there has never been a scan. type: string format: date-time readOnly: true scanScheduledTime: description: The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled. type: string format: date-time readOnly: true scanStartedTime: description: The timestamp of the most recently started scan, or empty if there has never been a scan. type: string format: date-time readOnly: true flowsListResult: type: object properties: value: type: array items: $ref: '#/definitions/flow' description: Flows array. x-ms-identifiers: - id nextLink: description: Link to next results type: string description: The flows list result. ListHubRouteTablesResult: description: List of RouteTables and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/HubRouteTable' description: List of RouteTables. nextLink: type: string description: URL to get the next set of operation list results if there are any. DeleteOrUpdateBehavior: description: The cleanup behavior to indicate whether clean up operation when resource is deleted or updated type: string enum: - Default - ForcedCleanup x-ms-enum: name: DeleteOrUpdateBehavior modelAsString: true RackSkuList: type: object title: RackSkuList represents a list of rack SKUs. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of Rack SKUs. type: array items: $ref: '#/definitions/RackSku' ListVirtualHubRouteTableV2sResult: description: List of VirtualHubRouteTableV2s and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VirtualHubRouteTableV2' description: List of VirtualHubRouteTableV2s. nextLink: type: string description: URL to get the next set of operation list results if there are any. SecretReference: type: object description: Secret reference and corresponding properties of a key vault secret. required: - referenceName - type - keyVaultObjectName properties: referenceName: type: string description: Reference name of the secret to be used in service configs. type: type: string description: 'Type of key vault object: secret, key or certificate.' enum: - Key - Secret - Certificate x-ms-enum: name: KeyVaultObjectType modelAsString: true version: type: string description: Version of the secret in key vault. keyVaultObjectName: type: string description: Object identifier name of the secret in key vault. pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,126}$ Sku_4: properties: name: type: string description: 'The SKU of the search service. Valid values include: ''free'': Shared service. ''basic'': Dedicated service with up to 3 replicas. ''standard'': Dedicated service with up to 12 partitions and 12 replicas. ''standard2'': Similar to standard, but with more capacity per search unit. ''standard3'': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to ''highDensity''). ''storage_optimized_l1'': Supports 1TB per partition, up to 12 partitions. ''storage_optimized_l2'': Supports 2TB per partition, up to 12 partitions.''' enum: - free - basic - standard - standard2 - standard3 - storage_optimized_l1 - storage_optimized_l2 x-ms-enum: name: SkuName modelAsString: true values: - value: free name: Free description: Free tier, with no SLA guarantees and a subset of features offered to paid tiers. - value: basic name: Basic description: Paid tier dedicated service with up to 3 replicas. - value: standard name: Standard description: Paid tier dedicated service with up to 12 partitions and 12 replicas. - value: standard2 name: Standard2 description: Similar to 'standard', but with more capacity per search unit. - value: standard3 name: Standard3 description: ' The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to ''highDensity'').' - value: storage_optimized_l1 name: StorageOptimizedL1 description: Paid tier dedicated service that supports 1TB per partition, up to 12 partitions. - value: storage_optimized_l2 name: StorageOptimizedL2 description: Paid tier dedicated service that supports 2TB per partition, up to 12 partitions. description: Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits. externalDocs: url: https://azure.microsoft.com/documentation/articles/search-sku-tier/ CredentialResult: type: object properties: name: type: string readOnly: true description: The name of the credential. value: type: string format: byte readOnly: true description: Base64-encoded Kubernetes configuration file. description: The credential result response. ErrorResponse_6: description: Describes the format of Error response. type: object properties: code: description: Error code type: string message: description: Error message indicating why the operation failed. type: string ListVpnServerConfigurationsResult: description: Result of the request to list all VpnServerConfigurations. It contains a list of VpnServerConfigurations and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnServerConfiguration' description: List of VpnServerConfigurations. nextLink: type: string description: URL to get the next set of operation list results if there are any. SearchServiceProperties: properties: replicaCount: type: integer format: int32 minimum: 1 maximum: 12 default: 1 description: The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. partitionCount: type: integer format: int32 minimum: 1 maximum: 12 default: 1 description: The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. hostingMode: type: string default: default description: Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'. enum: - default - highDensity x-ms-enum: name: HostingMode modelAsString: false values: - value: default name: Default description: The limit on number of indexes is determined by the default limits for the SKU. - value: highDensity name: HighDensity description: Only application for standard3 SKU, where the search service can have up to 1000 indexes. publicNetworkAccess: type: string default: enabled description: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. enum: - enabled - disabled x-ms-enum: name: PublicNetworkAccess modelAsString: true values: - value: enabled name: Enabled description: The search service is accessible from traffic originating from the public internet. - value: disabled name: Disabled description: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. status: readOnly: true type: string description: 'The status of the search service. Possible values include: ''running'': The search service is running and no provisioning operations are underway. ''provisioning'': The search service is being provisioned or scaled up or down. ''deleting'': The search service is being deleted. ''degraded'': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. ''disabled'': The search service is disabled. In this state, the service will reject all API requests. ''error'': The search service is in an error state. ''stopped'': The search service is in a subscription that''s disabled. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.' enum: - running - provisioning - deleting - degraded - disabled - error - stopped x-ms-enum: name: SearchServiceStatus modelAsString: false values: - value: running name: Running description: The search service is running and no provisioning operations are underway. - value: provisioning name: Provisioning description: The search service is being provisioned or scaled up or down. - value: deleting name: Deleting description: The search service is being deleted. - value: degraded name: Degraded description: The search service is degraded because underlying search units are not healthy. - value: disabled name: Disabled description: The search service is disabled and all API requests will be rejected. - value: error name: Error description: The search service is in error state, indicating either a failure to provision or to be deleted. - value: stopped name: Stopped description: The search service is in a subscription that's disabled. statusDetails: readOnly: true type: string description: The details of the search service status. provisioningState: readOnly: true type: string description: The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up. enum: - succeeded - provisioning - failed x-ms-enum: name: ProvisioningState modelAsString: false values: - value: succeeded name: Succeeded description: The last provisioning operation has completed successfully. - value: provisioning name: Provisioning description: The search service is being provisioned or scaled up or down. - value: failed name: Failed description: The last provisioning operation has failed. networkRuleSet: $ref: '#/definitions/NetworkRuleSet' description: Network specific rules that determine how the Azure Cognitive Search service may be reached. disabledDataExfiltrationOptions: type: array items: $ref: '#/definitions/DisabledDataExfiltrationOption' description: A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. encryptionWithCmk: $ref: '#/definitions/EncryptionWithCmk' description: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. disableLocalAuth: type: boolean x-nullable: true description: When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. authOptions: $ref: '#/definitions/DataPlaneAuthOptions' description: Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. semanticSearch: $ref: '#/definitions/SemanticSearch' x-nullable: true description: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. privateEndpointConnections: readOnly: true type: array items: $ref: '#/definitions/PrivateEndpointConnection_4' description: The list of private endpoint connections to the Azure Cognitive Search service. sharedPrivateLinkResources: readOnly: true type: array items: $ref: '#/definitions/SharedPrivateLinkResource' description: The list of shared private link resources managed by the Azure Cognitive Search service. eTag: readOnly: true type: string description: A system generated property representing the service's etag that can be for optimistic concurrency control during updates. description: Properties of the search service. DefaultErrorResponse: title: Default error response description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). type: object properties: error: description: The error object. $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail P2SConnectionConfiguration: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/P2SConnectionConfigurationProperties' description: Properties of the P2S connection configuration. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. allOf: - $ref: ./network.json#/definitions/SubResource description: P2SConnectionConfiguration Resource. ContainerGroupDiagnostics: description: Container group diagnostic information. type: object properties: logAnalytics: description: Container group log analytics information. $ref: '#/definitions/LogAnalytics' SkuEnumerationForNewResourceResult_2: description: An object that represents enumerating SKUs for new resources type: object properties: value: type: array items: $ref: '#/definitions/CapacitySku' x-ms-identifiers: - name description: The collection of available SKUs for new resources HardwareProfile: properties: hardwareType: readOnly: true type: string enum: - Cisco_UCS - HPE x-ms-enum: name: AzureBareMetalHardwareTypeNamesEnum modelAsString: true description: Name of the hardware type (vendor and/or their product name) azureBareMetalInstanceSize: readOnly: true type: string enum: - S72m - S144m - S72 - S144 - S192 - S192m - S192xm - S96 - S112 - S224 - S224m - S224om - S224oo - S224oom - S224ooo - S384 - S384m - S384xm - S384xxm - S448 - S448m - S448om - S448oo - S448oom - S448ooo - S576m - S576xm - S672 - S672m - S672om - S672oo - S672oom - S672ooo - S768 - S768m - S768xm - S896 - S896m - S896om - S896oo - S896oom - S896ooo - S960m x-ms-enum: name: azureBareMetalInstanceSizeNamesEnum modelAsString: true description: Specifies the AzureBareMetal instance SKU. description: Specifies the hardware settings for the AzureBareMetal instance. DocumentProcessorProperties: type: object description: Document processor properties properties: provisioningState: readOnly: true $ref: '#/definitions/ProvisioningState_5' description: The managed resource provisioning state. spoTenantUrl: type: string description: The URL of an SharePoint Online (SPO) tenant associated with this document processor resource spoTenantId: type: string description: The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource required: - spoTenantUrl - spoTenantId TrunkedNetwork: type: object title: TrunkedNetwork represents a network that utilizes multiple isolation domains and specified VLANs to create a trunked network. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/TrunkedNetworkProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true IdentityType: description: The type of identity that creates/modifies resources type: string enum: - User - Application - ManagedIdentity - Key x-ms-enum: name: IdentityType modelAsString: true CassandraError: type: object properties: code: description: The code of error that occurred. type: string message: description: The message of the error. type: string target: description: The target resource of the error. type: string additionalErrorInfo: description: Additional information about the error. type: string VirtualHubRouteV2: properties: destinationType: type: string description: The type of destinations. destinations: type: array description: List of all destinations. items: type: string nextHopType: type: string description: The type of next hops. nextHops: type: array description: NextHops ip address. items: type: string description: VirtualHubRouteTableV2 route. ExtensionType: type: object description: Represents an Extension Type. required: - properties properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ExtensionTypeProperties' description: Describes the Resource Type properties. systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData readOnly: true description: Metadata pertaining to creation and last modification of the resource. ErrorResponse_4: description: Describe the format of an Error response. type: object properties: error: description: The error details. $ref: '#/definitions/ErrorInfo' PolicyTrackedResource: type: object description: Policy tracked resource record. properties: trackedResourceId: description: The ID of the policy tracked resource. type: string readOnly: true policyDetails: $ref: '#/definitions/PolicyDetails' description: The details of the policy that require the tracked resource. readOnly: true createdBy: $ref: '#/definitions/TrackedResourceModificationDetails' description: The details of the policy triggered deployment that created the tracked resource. readOnly: true lastModifiedBy: $ref: '#/definitions/TrackedResourceModificationDetails' description: The details of the policy triggered deployment that modified the tracked resource. readOnly: true lastUpdateUtc: description: Timestamp of the last update to the tracked resource. type: string format: date-time readOnly: true EffectiveRoutesParameters: description: The parameters specifying the resource whose effective routes are being requested. properties: resourceId: type: string description: The resource whose effective routes are being requested. virtualWanResourceType: type: string description: The type of the specified resource like RouteTable, ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection. VpnServerConfigRadiusClientRootCertificate: properties: name: type: string description: The certificate name. thumbprint: type: string description: The Radius client root certificate thumbprint. description: Properties of the Radius client root certificate of VpnServerConfiguration. CheckNameAvailabilityInput_2: type: object required: - name - type properties: name: description: The search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. type: string type: description: The type of the resource whose name is to be validated. This value must always be 'searchServices'. type: string enum: - searchServices x-ms-enum: name: ResourceType modelAsString: false values: - value: searchServices name: SearchServices description: '''searchServices'' is the only resource type whose name can be validated.' description: Input of check name availability API. Volume: description: The properties of the volume. type: object required: - name properties: name: description: The name of the volume. type: string azureFile: description: The Azure File volume. $ref: '#/definitions/AzureFileVolume' emptyDir: description: The empty directory volume. $ref: '#/definitions/EmptyDirVolume' secret: description: The secret volume. $ref: '#/definitions/SecretVolume' gitRepo: description: The git repo volume. $ref: '#/definitions/GitRepoVolume' PolicyTrackedResourcesQueryResults: description: Query results. properties: value: description: Query results. type: array items: $ref: '#/definitions/PolicyTrackedResource' x-ms-identifiers: - trackedResourceId readOnly: true nextLink: type: string description: The URL to get the next set of results. readOnly: true BackupProperties: type: object description: Cloud Hsm Cluster backup information properties: azureStorageResourceUri: type: string description: Azure storage Resource Uri lastBackupDateTime: type: string format: date-time readOnly: true description: Last Date Time that Customer Enabled Backup was taken lastBackupStatus: type: string readOnly: true description: Status of last backup AzureMonitorPrivateLinkScopeListResult: description: Describes the list of Azure Monitor PrivateLinkScope resources. required: - value properties: value: type: array description: List of Azure Monitor PrivateLinkScope definitions. items: $ref: '#/definitions/AzureMonitorPrivateLinkScope' nextLink: type: string description: The URI to get the next set of Azure Monitor PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set. ResourceRequirements_2: description: This type describes the resource requirements for a container or a service. type: object properties: requests: $ref: '#/definitions/ResourceRequests_2' description: Describes the requested resources for a given container. limits: $ref: '#/definitions/ResourceLimits_2' description: Describes the maximum limits on the resources for a given container. required: - requests AutoDiscovery: enum: - Disabled - Enabled type: string x-ms-enum: name: AutoDiscovery modelAsString: true modelAsExtensible: true flowsPatch: type: object properties: identity: $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity description: The managed identity of the flow resource, if configured. tags: type: object additionalProperties: type: string description: Resource tags description: The flows resource patch definition. ClusterListResult: type: object properties: value: type: array items: $ref: '#/definitions/Cluster' description: The list of clusters. nextLink: description: The link (url) to the next page of results. type: string readOnly: true description: The list cluster operation response. BmcKeySetProperties: type: object title: BmcKeySetProperties represents the properties of baseboard management controller key set. required: - privilegeLevel - expiration - azureGroupId - userList properties: azureGroupId: description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. type: string x-ms-mutability: - read - create detailedStatus: description: The more detailed status of the key set. type: string enum: - AllActive - SomeInvalid - AllInvalid - Validating x-ms-enum: modelAsString: true name: BmcKeySetDetailedStatus readOnly: true detailedStatusMessage: description: The descriptive message about the current detailed status. type: string readOnly: true expiration: description: The date and time after which the users in this key set will be removed from the baseboard management controllers. type: string format: date-time lastValidation: description: The last time this key set was validated. type: string format: date-time readOnly: true privilegeLevel: description: The access level allowed for the users in this key set. type: string enum: - ReadOnly - Administrator x-ms-enum: modelAsString: true name: BmcKeySetPrivilegeLevel x-ms-mutability: - read - create provisioningState: description: The provisioning state of the baseboard management controller key set. type: string enum: - Succeeded - Failed - Canceled - Accepted - Provisioning x-ms-enum: modelAsString: true name: BmcKeySetProvisioningState readOnly: true userList: description: The unique list of permitted users. type: array items: $ref: '#/definitions/KeySetUser' x-ms-identifiers: - azureUserName userListStatus: description: The status evaluation of each user. type: array items: $ref: '#/definitions/KeySetUserStatus' x-ms-identifiers: - azureUserName readOnly: true AzureResource: properties: id: type: string readOnly: true description: Azure resource Id name: type: string readOnly: true description: Azure resource name type: type: string readOnly: true description: Azure resource type location: type: string description: Resource location x-ms-mutability: - create - read tags: additionalProperties: type: string type: object description: Resource tags required: - location type: object x-ms-azure-resource: true description: An azure resource object CommonEncryptionCenc: properties: enabledProtocols: $ref: '#/definitions/EnabledProtocols' description: Representing supported protocols clearTracks: type: array items: $ref: '#/definitions/TrackSelection' description: Representing which tracks should not be encrypted contentKeys: $ref: '#/definitions/StreamingPolicyContentKeys' description: Representing default content key for each encryption scheme and separate content keys for specific tracks drm: $ref: '#/definitions/CencDrmConfiguration' description: Configuration of DRMs for CommonEncryptionCenc encryption scheme type: object description: Class for envelope encryption scheme VpnGatewayIpConfiguration: description: IP Configuration of a VPN Gateway Resource. properties: id: type: string description: The identifier of the IP configuration for a VPN Gateway. publicIpAddress: type: string description: The public IP address of this IP configuration. privateIpAddress: type: string description: The private IP address of this IP configuration. CloudErrorBody_5: x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the error, intended to be suitable for displaying 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_5' description: A list of additional details about the error. description: An error response from Kusto. VirtualWanSecurityProviderType: type: string description: The virtual wan security provider type. readOnly: true enum: - External - Native x-ms-enum: name: VirtualWanSecurityProviderType modelAsString: true ContainerGroupListResult: description: The container group list response that contains the container group properties. type: object properties: value: type: array items: $ref: '#/definitions/ContainerGroup' description: The list of container groups. nextLink: type: string description: The URI to fetch the next page of container groups. PagedSessionDetails: type: object description: Paged collection of SessionDetails items properties: value: type: array description: The SessionDetails items on this page items: $ref: '#/definitions/SessionDetails' nextLink: type: string format: uri description: The link to the next page of items required: - value ContainerGroupProperties: description: The container group properties type: object required: - properties properties: identity: $ref: '#/definitions/ContainerGroupIdentity' description: The identity of the container group, if configured. properties: x-ms-client-flatten: true type: object description: The container group properties properties: provisioningState: readOnly: true type: string description: The provisioning state of the container group. This only appears in the response. containers: type: array description: The containers within the container group. items: $ref: '#/definitions/Container' x-ms-identifiers: - name imageRegistryCredentials: type: array description: The image registry credentials by which the container group is created from. items: $ref: '#/definitions/ImageRegistryCredential' x-ms-identifiers: - username provisioningTimeoutInSeconds: type: integer description: Time in seconds in which a container group deployment would timeout and fail. The allowed maximum value is 1800 seconds. If value is not provided, property is given maximum value by default. format: int32 isCustomProvisioningTimeout: type: string readOnly: true description: Flag indicating whether a custom value was provided for the provisioningTimeoutInSeconds property enum: - 'True' - 'False' x-ms-enum: name: IsCustomProvisioningTimeout modelAsString: true restartPolicy: type: string description: "Restart policy for all containers within the container group. \n- `Always` Always restart\n- `OnFailure` Restart on failure\n- `Never` Never restart\n" enum: - Always - OnFailure - Never x-ms-enum: name: ContainerGroupRestartPolicy modelAsString: true ipAddress: description: The IP address type of the container group. $ref: '#/definitions/IpAddress_2' osType: type: string description: The operating system type required by the containers in the container group. enum: - Windows - Linux x-ms-enum: name: OperatingSystemTypes modelAsString: true volumes: type: array description: The list of volumes that can be mounted by containers in this container group. items: $ref: '#/definitions/Volume' x-ms-identifiers: - name instanceView: description: The instance view of the container group. Only valid in response. readOnly: true type: object properties: events: description: The events of this container group. readOnly: true type: array items: $ref: '#/definitions/Event' x-ms-identifiers: - name - type state: readOnly: true type: string description: The state of the container group. Only valid in response. diagnostics: description: The diagnostic information for a container group. $ref: '#/definitions/ContainerGroupDiagnostics' subnetIds: type: array description: The subnet resource IDs for a container group. items: $ref: '#/definitions/ContainerGroupSubnetId' dnsConfig: description: The DNS config information for a container group. $ref: '#/definitions/DnsConfiguration' sku: description: The SKU for a container group. $ref: '#/definitions/ContainerGroupSku' encryptionProperties: description: The encryption properties for a container group. $ref: '#/definitions/EncryptionProperties' initContainers: type: array description: The init containers for a container group. items: $ref: '#/definitions/InitContainerDefinition' x-ms-identifiers: - name extensions: type: array description: extensions used by virtual kubelet items: $ref: '#/definitions/DeploymentExtensionSpec' x-ms-identifiers: - name required: - containers - osType VideoEntityCollection: properties: value: type: array items: $ref: '#/definitions/VideoEntity' description: A collection of VideoEntity items. '@nextLink': type: string description: A link to the next page of the collection (when the collection contains too many results to return in one response). type: object description: A collection of VideoEntity items. DatabaseInstanceProperties: description: The properties of database instance type: object properties: databaseInstanceId: description: Resource Id of existing database instance type: string databaseFqdn: description: Fully qualified domain name of existing database instance type: string readOnly: true dwDatabaseName: description: Name of warehouse database on database instance type: string readOnly: true operationalDatabaseId: description: Resource Id of operational database on database instance type: string readOnly: true dwDatabaseId: description: Resource Id of warehouse database on database instance type: string readOnly: true InitContainerPropertiesDefinition: description: The init container definition properties. type: object properties: image: description: The image of the init container. type: string command: description: The command to execute within the init container in exec form. type: array items: type: string environmentVariables: description: The environment variables to set in the init container. type: array items: $ref: '#/definitions/EnvironmentVariable' x-ms-identifiers: - name instanceView: description: The instance view of the init container. Only valid in response. readOnly: true type: object properties: restartCount: readOnly: true type: integer format: int32 description: The number of times that the init container has been restarted. currentState: readOnly: true description: The current state of the init container. $ref: '#/definitions/ContainerState' previousState: readOnly: true description: The previous state of the init container. $ref: '#/definitions/ContainerState' events: readOnly: true description: The events of the init container. type: array items: $ref: '#/definitions/Event' x-ms-identifiers: - name - type volumeMounts: description: The volume mounts available to the init container. type: array items: $ref: '#/definitions/VolumeMount' x-ms-identifiers: - name GroupLevelAccessControl: properties: publicNetworkAccess: type: string enum: - Enabled - Disabled x-ms-enum: name: PublicNetworkAccess values: - value: Enabled description: Public network access is enabled. - value: Disabled description: Public network access is disabled. modelAsString: true description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. x-nullable: true type: object description: Group level network access control. ActionList: type: object description: A list of Activity Log Alert rule actions. properties: actionGroups: description: The list of the Action Groups. type: array items: $ref: '#/definitions/ActionGroup_2' x-ms-identifiers: - actionGroupId ApplicationInsightsComponentListResult: description: Describes the list of Application Insights Resources. required: - value properties: value: type: array description: List of Application Insights component definitions. items: $ref: '#/definitions/ApplicationInsightsComponent' nextLink: type: string description: The URI to get the next set of Application Insights component definitions if too many components where returned in the result set. VpnServerConfigRadiusServerRootCertificate: properties: name: type: string description: The certificate name. publicCertData: type: string description: The certificate public data. description: Properties of Radius Server root certificate of VpnServerConfiguration. RoutingPolicy: required: - name - destinations - nextHop properties: name: type: string description: The unique name for the routing policy. destinations: type: array description: 'List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic).' items: type: string nextHop: type: string description: The next hop resource id on which this routing policy is applicable to. description: The routing policy object used in a RoutingIntent resource. type: object TargetServiceType: description: The target service type. type: string enum: - AzureResource - ConfluentBootstrapServer - ConfluentSchemaRegistry - SelfHostedServer x-ms-enum: name: targetServiceType modelAsString: true flowProperties: type: object properties: connection: $ref: '#/definitions/selectedResource' description: The connection associated with this flow flowId: type: string description: Dataflow GUID associated with this flow readOnly: true keyVaultUri: type: string description: AME, PME, or TORUS only! AKV Chain Containing SAS Token linkStatus: enum: - Linked - Unlinked type: string x-ms-enum: name: linkStatusFlow modelAsString: true description: Link status of the current flow readOnly: true linkedFlowId: type: string description: Resource ID of the linked flow readOnly: true status: enum: - Enabled - Disabled type: string x-ms-enum: name: flowStatus modelAsString: true description: Status of the current flow storageAccountName: type: string description: Storage Account storageAccountId: type: string format: arm-id description: Storage Account ID x-ms-arm-id-details: allowedResources: - scopes: - '*' type: Microsoft.Storage/storageAccounts storageContainerName: type: string description: Storage Container Name serviceBusQueueId: type: string format: arm-id description: Service Bus Queue ID x-ms-arm-id-details: allowedResources: - scopes: - '*' type: Microsoft.Storage/namespaces/queues flowType: $ref: '#/definitions/flowType' description: The flow type for this flow dataType: enum: - Blob - Table type: string x-ms-enum: name: dataType modelAsString: true description: Transfer Storage Blobs or Tables provisioningState: description: Provisioning state of the flow enum: - Failed - Succeeded - Canceled - Accepted type: string x-ms-enum: name: provisioningState modelAsString: true readOnly: true policies: type: array description: The policies for this flow items: type: string schema: $ref: '#/definitions/schema' description: The selected schema for this flow description: Properties of flow ConnectionDetail: type: object properties: id: type: string readOnly: true description: Azure resource Id privateIpAddress: type: string readOnly: true description: The private endpoint connection private ip address linkIdentifier: type: string readOnly: true description: The private endpoint connection link identifier groupId: type: string readOnly: true description: The private endpoint connection group id memberName: type: string readOnly: true description: The private endpoint connection member name ResourceId: description: Defines resource ID of a private endpoint connection. type: object properties: id: type: string readOnly: true VirtualWanSecurityProviders: properties: supportedProviders: type: array items: $ref: '#/definitions/VirtualWanSecurityProvider' description: List of VirtualWAN security providers. description: Collection of SecurityProviders. DiagnosticStorageProperties: description: Customer-initiated diagnostic log collection storage properties type: object properties: authenticationType: description: Authentication Type enum: - KeyBased type: string readOnly: false x-ms-enum: name: AuthenticationType modelAsString: true connectionString: description: ConnectionString of the diagnostic storage account x-ms-secret: true type: string resourceId: description: ResourceId of the diagnostic storage account type: string required: - authenticationType - resourceId PrivateEndpointConnectionProperties_2: type: object description: Properties of a private endpoint connection. properties: provisioningState: enum: - Accepted - InProgress - Succeeded - Failed - Canceled type: string description: Provisioning state. x-ms-enum: name: provisioningState modelAsString: true readOnly: true privateEndpoint: $ref: '#/definitions/ResourceId' readOnly: true privateLinkServiceConnectionState: $ref: '#/definitions/PrivateLinkServiceConnectionState' description: Gets the properties of the object. UserAssignedIdentities: type: object description: 'The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''.' properties: principalId: readOnly: true type: string description: The principal id of user assigned identity. clientId: readOnly: true type: string description: The client id of user assigned identity. DirectoryTenantHealthReportList: description: List of directory tenant health reports. properties: value: type: array description: Directory tenant health report. items: $ref: '#/definitions/DirectoryTenantHealthReport' x-ms-identifiers: - tenantId nextLink: description: URI to the next page. type: string IpAddress_2: description: IP address for the container group. type: object properties: ports: type: array description: The list of ports exposed on the container group. items: $ref: '#/definitions/Port' x-ms-identifiers: - port type: type: string description: Specifies if the IP is exposed to the public internet or private VNET. enum: - Public - Private x-ms-enum: name: ContainerGroupIpAddressType modelAsString: true ip: type: string description: The IP exposed to the public internet. dnsNameLabel: type: string description: The Dns name label for the IP. autoGeneratedDomainNameLabelScope: type: string description: The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. enum: - Unsecure - TenantReuse - SubscriptionReuse - ResourceGroupReuse - Noreuse default: Unsecure x-ms-enum: name: dnsNameLabelReusePolicy modelAsString: true fqdn: readOnly: true type: string description: The FQDN for the IP. required: - ports - type GitHubConnectorStatsListResponse: type: object properties: value: description: Gets or sets list of resources. type: array items: $ref: '#/definitions/GitHubConnectorStats' x-ms-identifiers: [] nextLink: description: Gets or sets next link to scroll over the results. type: string connectionsPatch: type: object properties: tags: type: object additionalProperties: type: string description: Resource tags description: The connections resource patch definition. FieldRestriction: description: The restrictions on a field imposed by a specific policy. properties: result: description: The type of restriction that is imposed on the field. type: string enum: - Required - Removed - Deny x-ms-enum: name: FieldRestrictionResult modelAsString: true values: - value: Required description: The field and/or values are required by policy. - value: Removed description: The field will be removed by policy. - value: Deny description: The field and/or values will be denied by policy. readOnly: true defaultValue: description: The value that policy will set for the field if the user does not provide a value. type: string readOnly: true values: description: The values that policy either requires or denies for the field. type: array items: type: string readOnly: true policy: description: The details of the policy that is causing the field restriction. $ref: '#/definitions/PolicyReference' readOnly: true RegionConfigurationResponse: description: Configuration response specific to a region. type: object properties: scheduleAvailabilityResponse: $ref: '#/definitions/ScheduleAvailabilityResponse' description: Schedule availability for given sku in a region. readOnly: true transportAvailabilityResponse: $ref: '#/definitions/TransportAvailabilityResponse' description: Transport options available for given sku in a region. readOnly: true datacenterAddressResponse: $ref: '#/definitions/DatacenterAddressResponse' description: Datacenter address for given sku in a region. readOnly: true deviceCapabilityResponse: $ref: '#/definitions/DeviceCapabilityResponse' description: Device capabilities available for a given sku in a region. readOnly: true AccessMode: description: Access mode types. type: string enum: - Open - PrivateOnly x-ms-enum: name: AccessMode modelAsString: true PagedProviderStatus: type: object description: Paged collection of ProviderStatus items properties: value: type: array description: The ProviderStatus items on this page items: $ref: '#/definitions/ProviderStatus' nextLink: type: string format: uri description: The link to the next page of items required: - value NetworkVirtualApplianceConnection: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/NetworkVirtualApplianceConnectionProperties' description: Properties of the express route connection. name: type: string description: The name of the resource. allOf: - $ref: ./network.json#/definitions/SubResource description: NetworkVirtualApplianceConnection resource. UpdatePrerequisite: description: If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. type: object properties: updateType: description: Updatable component type. type: string version: description: Version of the prerequisite. type: string packageName: description: Friendly name of the prerequisite. type: string AlertRuleAllOfCondition: description: An Activity Log Alert rule condition that is met when all its member conditions are met. type: object properties: allOf: description: The list of Activity Log Alert rule conditions. type: array items: $ref: '#/definitions/AlertRuleAnyOfOrLeafCondition' x-ms-identifiers: [] required: - allOf RacksPatchProperties: type: object title: RacksPatchProperties represents the properties of the rack during patching. properties: rackLocation: description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) type: string maxLength: 256 rackSerialNumber: description: The globally unique identifier for the rack. type: string maxLength: 64 minLength: 1 CheckNameAvailabilityOutput_2: type: object properties: nameAvailable: x-ms-client-name: IsNameAvailable description: A value indicating whether the name is available. type: boolean readOnly: true reason: description: The reason why the name is not available. 'Invalid' indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists' indicates that the name is already in use and is therefore unavailable. type: string readOnly: true enum: - Invalid - AlreadyExists x-ms-enum: name: UnavailableNameReason modelAsString: true values: - value: Invalid name: Invalid description: The search service name does not match naming requirements. - value: AlreadyExists name: AlreadyExists description: The search service name is already assigned to a different search service. message: description: A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property. type: string readOnly: true description: Output of check name availability API. SubscriptionList_2: description: List of subscriptions. properties: value: type: array description: Subscription definition. items: $ref: '#/definitions/SubscriptionDefinition' nextLink: description: URI to the next page. type: string EtwEventConfiguration: type: object required: - name - id properties: name: type: string id: type: integer filter: type: string AgentPoolPatchProperties: type: object title: AgentPoolPatchProperties represents the properties of an agent pool that can be modified. properties: administratorConfiguration: $ref: '#/definitions/NodePoolAdministratorConfigurationPatch' description: The configuration of administrator credentials for the control plane nodes. count: description: The number of virtual machines that use this configuration. type: integer format: int64 upgradeSettings: $ref: '#/definitions/AgentPoolUpgradeSettings' description: The configuration of the agent pool. DatacenterAddressResponse: description: Datacenter address for given storage location. required: - datacenterAddressType type: object properties: datacenterAddressType: description: Data center address type enum: - DatacenterAddressLocation - DatacenterAddressInstruction type: string x-ms-enum: name: DatacenterAddressType modelAsExtensible: false values: - value: DatacenterAddressLocation description: Data center address location. - value: DatacenterAddressInstruction description: Data center address instruction. supportedCarriersForReturnShipment: description: List of supported carriers for return shipment. uniqueItems: false type: array items: type: string readOnly: true dataCenterAzureLocation: description: Azure Location where the Data Center serves primarily. type: string readOnly: true discriminator: datacenterAddressType AzureDevOpsConnector: type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource properties: properties: $ref: '#/definitions/AzureDevOpsConnectorProperties' CanonicalSupportPlanProperties: type: object description: The properties of the Canonical support plan. properties: provisioningState: type: string description: The provisioning state of the resource. enum: - Succeeded - Failed - Cancelled - Purchasing - Downgrading - Cancelling - Upgrading x-ms-enum: name: ProvisioningState modelAsString: true StreamingLocatorCollection: properties: value: type: array items: $ref: '#/definitions/StreamingLocator' description: A collection of StreamingLocator items. '@odata.nextLink': type: string description: A link to the next page of the collection (when the collection contains too many results to return in one response). type: object description: A collection of StreamingLocator items. PublicNetworkAccessType_3: type: string description: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). default: Disabled enum: - Enabled - Disabled x-ms-enum: name: PublicNetworkAccessType modelAsString: true values: - value: Enabled description: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. - value: Disabled description: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. VpnServerConfigurationPolicyGroup: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnServerConfigurationPolicyGroupProperties' description: Properties of the VpnServerConfigurationPolicyGroup. etag: type: string readOnly: true description: A unique read-only string that changes whenever the resource is updated. name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. type: readOnly: true type: string description: Resource type. allOf: - $ref: ./network.json#/definitions/SubResource description: VpnServerConfigurationPolicyGroup Resource. AzureDevOpsProjectProperties: description: AzureDevOps Project properties. type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState_3' orgName: description: Gets or sets AzureDevOps org Name. type: string projectId: description: Gets or sets AzureDevOps Project Id. type: string autoDiscovery: $ref: '#/definitions/AutoDiscovery' Provider: type: object description: Information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs. properties: providerId: type: string description: Unique id of this provider. providerSku: type: string description: The sku associated with pricing information for this provider. instanceUri: type: string description: A Uri identifying the specific instance of this provider. applicationName: type: string description: The provider's marketplace application display name. provisioningState: type: string enum: - Succeeded - Launching - Updating - Deleting - Deleted - Failed x-ms-enum: name: Status modelAsString: true description: Provisioning status field resourceUsageId: type: string description: Id to track resource usage for the provider. ContainerLabel: description: Describes a container label. type: object properties: name: description: The name of the container label. type: string value: description: The value of the container label. type: string required: - name - value BareMetalMachineReplaceParameters: type: object title: BareMetalMachineReplaceParameters represents the body of the request to physically swap a bare metal machine for another. properties: bmcCredentials: $ref: '#/definitions/AdministrativeCredentials' description: The credentials of the baseboard management controller on this bare metal machine. bmcMacAddress: description: The MAC address of the BMC device. type: string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ bootMacAddress: description: The MAC address of a NIC connected to the PXE network. type: string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ machineName: description: The OS-level hostname assigned to this machine. type: string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ serialNumber: description: The serial number of the bare metal machine. type: string maxLength: 64 minLength: 1 ThroughputPoolAccountProperties: description: An Azure Cosmos DB Global Database Account which is part of a Throughputpool. type: object x-ms-mutability: - read - create - update properties: provisioningState: $ref: '#/definitions/ProvisioningState_2' description: A provisioning state of the ThroughputPool Account. accountResourceIdentifier: description: The resource identifier of global database account in the throughputPool. type: string accountLocation: description: The location of global database account in the throughputPool. type: string accountInstanceId: description: The instance id of global database account in the throughputPool. type: string readOnly: true HealthBotUpdateParameters: type: object description: Parameters for updating a Azure Health Bot. properties: properties: $ref: '#/definitions/HealthBotProperties' description: Properties of Azure Health Bot. tags: type: object description: Tags for a Azure Health Bot. additionalProperties: type: string x-ms-mutability: - read - create - update sku: $ref: '#/definitions/Sku' description: SKU of the Azure Health Bot. identity: $ref: '#/definitions/Identity' description: The identity of the Azure Health Bot. location: type: string x-ms-mutability: - create - read TargetAvailability: type: string description: Target availability. enum: - Available - Degraded - Unavailable x-ms-enum: name: TargetAvailability modelAsString: true values: - name: Available value: Available description: Target is available. - name: Degraded value: Degraded description: Target is available with degraded experience. - name: Unavailable value: Unavailable description: Target is unavailable. RestoreProperties: type: object description: Cloud Hsm Cluster restore information properties: foldername: type: string description: Directory name in Azure Storage Blob where the backup is stored azureStorageResourceUri: type: string description: Azure Blob storage container Uri AadProfile: type: object description: AAD Profile specifies attributes for Azure Active Directory integration. properties: enableAzureRBAC: type: boolean description: Whether to enable Azure RBAC for Kubernetes authorization. adminGroupObjectIDs: type: array items: type: string description: The list of AAD group object IDs that will have admin role of the cluster. tenantID: type: string description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. MoveResourceError: properties: properties: type: object description: The move resource error body. $ref: '#/definitions/MoveResourceErrorBody' description: An error response from the azure resource mover service. Resource_2: properties: id: type: string readOnly: true description: Azure resource Id name: type: string readOnly: true description: Azure resource name. This is GUID value. The display name should be assigned within properties field. location: type: string readOnly: true description: The location of the resource type: type: string readOnly: true description: Azure resource type x-ms-azure-resource: true description: An azure resource object NetworkProfile: properties: networkInterfaces: type: array items: $ref: '#/definitions/IpAddress' x-ms-identifiers: - ipAddress description: Specifies the network interfaces for the AzureBareMetal instance. circuitId: readOnly: true type: string description: Specifies the circuit id for connecting to express route. description: Specifies the network settings for the AzureBareMetal instance disks. GitHubOwnerProperties: description: GitHub Repo Owner properties. type: object properties: provisioningState: $ref: '#/definitions/ProvisioningState_3' ownerUrl: description: Gets or sets gitHub owner url. type: string ErrorAdditionalInfo: type: object properties: type: readOnly: true type: string description: The additional info type. info: readOnly: true type: object description: The additional info. description: The resource management error additional info. BotResponseList: type: object properties: nextLink: readOnly: true description: The link used to get the next page of bot service resources. type: string value: readOnly: true type: array items: $ref: '#/definitions/HealthBot' description: Gets the list of Azure Health Bot results and their properties. description: The list of Azure Health Bot operation response. ErrorFieldContract: properties: code: type: string description: Property level error code. message: type: string description: Human-readable representation of property-level error. target: type: string description: Property name. description: Error Field contract. ClusterPoolComputeProfile: type: object description: Cluster pool compute profile. required: - vmSize properties: vmSize: type: string description: The virtual machine SKU. pattern: ^[a-zA-Z0-9_\-]{0,256}$ count: description: The number of virtual machines. type: integer format: int32 readOnly: true AadAuthenticationParameters: properties: aadTenant: type: string description: AAD Vpn authentication parameter AAD tenant. aadAudience: type: string description: AAD Vpn authentication parameter AAD audience. aadIssuer: type: string description: AAD Vpn authentication parameter AAD issuer. description: AAD Vpn authentication type related parameters. VirtualHubRouteTable: properties: routes: type: array description: List of all routes. items: $ref: '#/definitions/VirtualHubRoute' description: VirtualHub route table. RequiredForResourcesCollection: description: Required for resources collection. type: object properties: sourceIds: description: Gets or sets the list of source Ids for which the input resource is required. type: array items: type: string BareMetalMachineConfigurationData: type: object title: BareMetalMachineConfigurationData represents configuration for the bare metal machine. required: - rackSlot - bootMacAddress - bmcCredentials - bmcMacAddress - serialNumber properties: bmcConnectionString: description: The connection string for the baseboard management controller including IP address and protocol. type: string readOnly: true bmcCredentials: $ref: '#/definitions/AdministrativeCredentials' description: The credentials of the baseboard management controller on this bare metal machine. bmcMacAddress: description: The MAC address of the BMC for this machine. type: string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ bootMacAddress: description: The MAC address associated with the PXE NIC card. type: string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ machineDetails: description: The free-form additional information about the machine, e.g. an asset tag. type: string maxLength: 256 machineName: description: 'The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.' type: string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ rackSlot: description: The slot the physical machine is in the rack based on the BOM configuration. type: integer format: int64 maximum: 256 minimum: 1 serialNumber: description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. type: string maxLength: 64 BareMetalMachineKeySetList: type: object title: BareMetalMachineKeySetList represents a list of bare metal machine key sets. properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of bare metal machine key sets. type: array items: $ref: '#/definitions/BareMetalMachineKeySet' BareMetalMachineKeySet: type: object title: BareMetalMachineKeySet represents the bare metal machine key set. required: - extendedLocation - properties properties: extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location of the cluster associated with the resource. properties: $ref: '#/definitions/BareMetalMachineKeySetProperties' description: The list of the resource properties. x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource x-ms-azure-resource: true ClusterDeployParameters: type: object title: ClusterDeployParameters represents the body of the request to deploy cluster. properties: skipValidationsForMachines: description: The names of bare metal machines in the cluster that should be skipped during environment validation. type: array items: type: string pendingConnection: type: object description: Pending connection object properties: subscriptionId: type: string description: Subscription ID of the pending connection. readOnly: true allOf: - $ref: '#/definitions/connectionProperties' - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource GuestDiagnosticSettingsAssociationResource: type: object allOf: - $ref: '#/definitions/Resource_6' required: - properties properties: properties: x-ms-client-flatten: true $ref: '#/definitions/GuestDiagnosticSettingsAssociation' description: The diagnostics settings associations of the resource. description: Virtual machine guest diagnostic settings resource. ODataError: properties: code: type: string description: A language-independent error name. message: type: string description: The error message. target: type: string description: The target of the error (for example, the name of the property in error). details: type: array items: $ref: '#/definitions/ODataError' description: The error details. type: object description: Information about an error. parameters: AzureDevOpsRepoName: in: path name: azureDevOpsRepoName description: Name of the AzureDevOps Repo. required: true type: string x-ms-parameter-location: method ServiceEndpointNameParameter: description: The name of the ServiceEndpoint resource. type: string name: serviceEndpointName in: path required: true x-ms-parameter-location: method SubscriptionDefinitionParameter: description: Subscription parameter. name: subscriptionDefinition in: body schema: $ref: '#/definitions/Subscription' required: true x-ms-parameter-location: method ComponentPurgeIdParameter: name: purgeId in: path required: true type: string description: In a purge status request, this is the Id of the operation the status of which is returned. x-ms-parameter-location: method apiVersionParameter_10: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client ExtensionLocationParameter: name: location in: path description: extension location required: true type: string x-ms-parameter-location: method LocationParameter_3: name: location in: path required: true type: string x-ms-parameter-location: method description: The location of the target resource. minLength: 1 queryParam: name: query in: query required: true x-ms-parameter-location: method description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) type: string ContainerGroupNameParameter: name: containerGroupName in: path required: true type: string description: The name of the container group. x-ms-parameter-location: method peConnectionName: name: peConnectionName in: path required: true type: string description: Name of the private endpoint connection associated with the Cloud HSM Cluster. pattern: ^[a-zA-Z0-9-]{3,24}$ maxLength: 24 minLength: 3 x-ms-parameter-location: method SubscriptionDefinitionParameter_2: description: Subscription parameter. name: subscriptionDefinition in: body schema: $ref: '#/definitions/SubscriptionDefinition' required: true x-ms-parameter-location: method apply: name: $apply in: query required: false type: string description: OData apply expression for aggregations. x-ms-parameter-location: method x-ms-client-name: Apply locationParameter: name: location in: path description: The location of the resource required: true type: string x-ms-parameter-location: method SubscriptionIdParameter_14: name: subscriptionId in: path required: true type: string description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. eventsSearch: name: $search in: query x-ms-parameter-location: method description: A free-text search expression to match for whether a particular event should be returned type: string apiVersionParameter_5: name: api-version description: Version of the API to be used with the client request. The current version is 2015-10-01. in: query required: true type: string AccountNameParameter_2: name: accountName in: path required: true type: string description: Account name. x-ms-parameter-location: method pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ minLength: 3 maxLength: 24 virtualNetworksNameParameter: name: virtualNetworksName description: Parameter for the name of the virtual network in: path required: true type: string x-ms-parameter-location: method maxLength: 64 minLength: 3 ResourceNameParameter_3: name: resourceName in: path required: true type: string description: The name of the resource. x-ms-parameter-location: method to: name: $to in: query required: false type: string format: date-time description: ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. x-ms-parameter-location: method x-ms-client-name: To ApiVersionParameter_6: name: api-version in: query required: true type: string description: The API version to be used with the HTTP request. apiVersionParameter_4: name: api-version in: query required: true type: string description: Version of the API to be used with the client request. top: name: $top in: query required: false type: integer format: int32 minimum: 0 description: Maximum number of records to return. x-ms-parameter-location: method x-ms-client-name: Top dataCenterNameParameter: name: dataCenterName in: path required: true type: string x-ms-parameter-location: method description: Data center name in a managed Cassandra cluster. minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ metricsTimespan: name: timespan in: query required: false x-ms-parameter-location: method description: The timespan over which to retrieve metric values. This is an ISO8601 time period value. If timespan is omitted, a default time range of `PT12H` ("last 12 hours") is used. The actual timespan that is queried may be adjusted by the server based. In all cases, the actual time span used for the query is included in the response. type: string AccountNameParameter_3: description: The name of the RecommendationsService Account resource. type: string name: accountName in: path required: true x-ms-parameter-location: method eventsFormat: name: $format in: query x-ms-parameter-location: method description: Format for the returned events type: string Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion instanceName: name: instanceName pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*$ in: path required: true type: string description: Name of the Azure Monitor Operations Manager Managed Instance (SCOM MI) x-ms-parameter-location: method ThroughputPoolAccountNameParameter: name: throughputPoolAccountName in: path required: true type: string x-ms-parameter-location: method description: Cosmos DB global database account in a Throughput Pool minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)* BareMetalMachineNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the bare metal machine. name: bareMetalMachineName in: path required: true policyStatesSummaryResourceParameter: name: policyStatesSummaryResource in: path required: true type: string enum: - latest description: The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value. x-ms-parameter-location: method SkipQueryParameter: name: $skip in: query required: false type: integer format: int32 description: Number of records to skip. minimum: 1 x-ms-parameter-location: method SupportProviderName: name: providerName in: path required: true type: string description: The support plan type. For now the only valid type is "canonical". x-ms-parameter-location: method authorizationNamespace: name: authorizationNamespace in: path required: true type: string enum: - Microsoft.Authorization x-ms-enum: name: AuthorizationNamespaceType modelAsString: false description: The namespace for Microsoft Authorization resource provider; only "Microsoft.Authorization" is allowed. x-ms-parameter-location: method ProcessorNameParameter: name: processorName in: path required: true type: string description: The name of document processor resource. x-ms-parameter-location: method resourceGroupNameParameter_3: name: resourceGroupName in: path description: The Resource Group Name required: true type: string x-ms-parameter-location: method pipelineNameParameter: x-ms-parameter-location: method name: pipelineName in: path required: true type: string pattern: ^[a-zA-Z0-9-]{3,64}$ maxLength: 64 minLength: 3 description: The name for the pipeline that is to be requested. ConnectorNameParameter: name: connectorName in: path required: true type: string description: The name of resource. x-ms-parameter-location: method api-version_2: in: query name: api-version description: Client Api Version. required: true type: string OfferTypeParameter: name: offerType in: path required: true description: Offer Type, currently only virtualmachine type is supported. x-ms-parameter-location: method enum: - virtualmachine type: string x-ms-enum: name: OfferType modelAsString: true policySetDefinitionNameParameter: name: policySetDefinitionName in: path required: true type: string description: Policy set definition name. x-ms-parameter-location: method MoveSubscriptionsParameter: description: Move subscriptions parameter. name: moveSubscriptionsDefinition in: body schema: $ref: '#/definitions/MoveSubscriptionsDefinition' required: true x-ms-parameter-location: method ClusterManagerNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the cluster manager. name: clusterManagerName in: path required: true policyAssignmentName: name: policyAssignmentName in: path required: true type: string description: Policy assignment name. pattern: ^[^<>%&:\\?/#]*$ minLength: 1 maxLength: 64 x-ms-parameter-location: method ApiVersionParameter_10: name: api-version in: query description: Version of API to invoke. required: true type: string FilterParameter: name: $filter in: query x-ms-parameter-location: method description: OData filter expression to apply to the query. required: false type: string PublishersParameter: name: publisherId in: path required: true type: string x-ms-parameter-location: method description: Publisher identifier string of image being deployed. select: name: $select in: query required: false type: string description: Select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". x-ms-parameter-location: method x-ms-client-name: Select ServiceName: name: serviceName in: path required: true description: Service name pattern: ^[a-zA-Z0-9\-]{1,64}$ type: string x-ms-parameter-location: method SubscriptionIdParameter_16: name: subscriptionId in: path required: true type: string description: The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. resourceGroupName_3: name: resourceGroupName in: path required: true type: string description: Resource group name. x-ms-parameter-location: method CanonicalSupportPlanType: name: planTypeName in: path required: true type: string description: The Canonical support plan type. enum: - Essential - Standard - Advanced x-ms-enum: name: PlanTypeName modelAsString: true x-ms-parameter-location: method metricsSegment: name: segment in: query collectionFormat: csv x-ms-parameter-location: method description: The name of the dimension to segment the metric values by. This dimension must be applicable to the metric you are retrieving. To segment by more than one dimension at a time, separate them with a comma (,). In this case, the metric data will be segmented in the order the dimensions are listed in the parameter. type: array minItems: 1 items: type: string enum: - applicationBuild - applicationVersion - authenticatedOrAnonymousTraffic - browser - browserVersion - city - cloudRoleName - cloudServiceName - continent - countryOrRegion - deploymentId - deploymentUnit - deviceType - environment - hostingLocation - instanceName x-ms-enum: name: MetricsSegment modelAsString: true applicationName: name: applicationName description: Name of the Application Insights application. in: path required: true type: string x-ms-parameter-location: method resourceGroupName_5: in: path name: resourceGroupName description: The Resource Group Name. required: true type: string x-ms-parameter-location: method L3NetworkNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the L3 network. name: l3NetworkName in: path required: true GitHubOwnerName: in: path name: gitHubOwnerName description: Name of the GitHub Owner. required: true type: string x-ms-parameter-location: method subscriptionIdParameter_3: name: subscriptionId in: path description: The Subscription Id required: true type: string ThroughputPoolNameParameter: name: throughputPoolName in: path required: true type: string x-ms-parameter-location: method description: Cosmos DB Throughput Pool name. minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)* OffersParameter: name: offerId in: path required: true type: string x-ms-parameter-location: method description: Offer identifier string of image being deployed. LocationParameter_4: name: location in: path required: true type: string description: The location of network security perimeter. x-ms-parameter-location: method SubnetNameParameter: name: subnetName in: path required: true type: string description: The name of the subnet. x-ms-parameter-location: method AzureDevOpsConnectorName: in: path name: azureDevOpsConnectorName description: Name of the AzureDevOps Connector. required: true type: string x-ms-parameter-location: method eventsOrderBy: name: $orderby in: query x-ms-parameter-location: method description: A comma-separated list of properties with \"asc\" (the default) or \"desc\" to control the order of returned events type: string GraphQueryResourceNameParameter: name: resourceName in: path required: true type: string description: The name of the Graph Query resource. x-ms-parameter-location: method monitorNameFilter: name: $filter in: query description: 'Optionally filter by monitor name. Example: $filter=monitorName eq ''logical-disks|C:|disk-free-space-mb.''' required: false type: string x-ms-parameter-location: method metricId: name: metricId in: path required: true x-ms-parameter-location: method description: ID of the metric. This is either a standard AI metric, or an application-specific custom metric. type: string enum: - requests/count - requests/duration - requests/failed - users/count - users/authenticated - pageViews/count - pageViews/duration - client/processingDuration - client/receiveDuration - client/networkDuration - client/sendDuration - client/totalDuration - dependencies/count - dependencies/failed - dependencies/duration - exceptions/count - exceptions/browser - exceptions/server - sessions/count - performanceCounters/requestExecutionTime - performanceCounters/requestsPerSecond - performanceCounters/requestsInQueue - performanceCounters/memoryAvailableBytes - performanceCounters/exceptionsPerSecond - performanceCounters/processCpuPercentage - performanceCounters/processIOBytesPerSecond - performanceCounters/processPrivateBytes - performanceCounters/processorCpuPercentage - availabilityResults/availabilityPercentage - availabilityResults/duration - billing/telemetryCount - customEvents/count x-ms-enum: name: MetricId modelAsString: true MachineNameParameter: name: machineName in: path required: true type: string description: The name of the target machine to get the private link scope validation details for. minLength: 1 x-ms-parameter-location: method apiVersionParameter_2: name: api-version in: query required: true type: string description: Version of the API to be used with the client request. ApiVersion: name: api-version in: query required: true type: string description: The Version of the API to be used with the client request. CommonParams.workspaceName: name: workspaceName in: path description: Name of the Azure Quantum workspace. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$ x-ms-parameter-location: client KubernetesClusterNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the Kubernetes cluster. name: kubernetesClusterName in: path required: true queryBody: name: body in: body description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) required: true schema: $ref: '#/definitions/queryBody' x-ms-parameter-location: method subscriptionIdParameter_9: name: subscriptionId in: path required: true type: string description: Microsoft Azure subscription ID. policyDefinitionNameParameter: name: policyDefinitionName in: path required: true type: string description: Policy definition name. x-ms-parameter-location: method SubscriptionId: name: subscriptionId in: path required: true type: string description: The unique identifier for a Microsoft Azure subscription. VirtualMachineNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the virtual machine. name: virtualMachineName in: path required: true expand: name: $expand in: query description: 'Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration.' required: false type: string x-ms-parameter-location: method filterParameter: name: $filter in: query required: false type: string description: OData filter expression. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Filter ApiVersionParameter: name: api-version in: query required: true type: string description: Client API version. subscriptionId_7: in: path name: subscriptionId required: true type: string description: The subscription Id of the virtual machine. x-ms-parameter-location: method SearchServiceNameParameter: name: searchServiceName in: path required: true type: string description: The name of the Azure Cognitive Search service associated with the specified resource group. x-ms-parameter-location: method ModelingNameParameter: description: The name of the Modeling resource. type: string name: modelingName in: path required: true x-ms-parameter-location: method ApiVersionParameter_3: name: api-version in: query required: true type: string description: Client Api Version. metricsFilter: name: filter in: query x-ms-parameter-location: method description: An expression used to filter the results. This value should be a valid OData filter expression where the keys of each clause should be applicable dimensions for the metric you are retrieving. type: string subscriptionIdParameter_6: name: subscriptionId in: path required: true type: string description: Microsoft Azure subscription ID. x-ms-parameter-location: method GitHubRepoName: in: path name: gitHubRepoName description: Name of the GitHub Repo. required: true type: string x-ms-parameter-location: method LocationParameter_2: name: location in: path required: true type: string description: The identifier for the physical azure location. x-ms-parameter-location: method resourceGroupNameParameter_2: name: resourceGroupName x-ms-parameter-location: method in: path required: true type: string maxLength: 64 minLength: 2 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ description: The name of the Bot resource group in the user subscription. InstanceNameParameter: name: instanceName in: path required: true type: string description: Instance name. x-ms-parameter-location: method pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ minLength: 3 maxLength: 36 StorageTypeParameter: name: storageType in: path required: true type: string enum: - ServiceProfiler x-ms-enum: name: StorageType modelAsString: true description: The type of the Application Insights component data source for the linked storage account. x-ms-parameter-location: method SubscriptionIdParameter_4: name: subscriptionId in: path required: true type: string description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. api-version: name: api-version description: Standard request header. Used by service to identify API version used by client. type: string in: query required: true enum: - 2017-11-11-preview ResourceGroupNameRequiredPathParam: name: resourceGroupName in: path description: Azure resource group name required: true type: string x-ms-parameter-location: method subscriptionIdParameter_4: name: subscriptionId in: path description: Azure Subscription ID. required: true type: string assessmentName: name: assessmentName description: Unique name of an assessment within a project. type: string in: path x-ms-parameter-location: method required: true ApiVersionParameter_13: name: api-version in: query required: true type: string description: The client API version. DiagnosticSettingNameParameter: name: diagnosticSettingsName in: path required: true type: string description: The name of the diagnostic setting. x-ms-parameter-location: method attestationNameParameter: name: attestationName in: path required: true type: string description: The name of the attestation. x-ms-parameter-location: method orderBy: name: $orderby in: query required: false type: string description: Ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". x-ms-parameter-location: method x-ms-client-name: OrderBy ClusterNamePathParam: name: clusterName in: path required: true type: string description: The name of the Kubernetes cluster on which get is called. x-ms-parameter-location: method OrderbyParameter: name: $orderby in: query x-ms-parameter-location: method description: OData orderBy expression to apply to the query. required: false type: string AzureVideoAnalyzerAccountName: name: accountName in: path required: true type: string description: The Azure Video Analyzer account name. x-ms-parameter-location: method SubscriptionIdParameter_15: name: subscriptionId in: path required: true type: string description: The Microsoft Azure subscription ID. subscriptionId_3: name: subscriptionId in: path required: true type: string description: Microsoft Azure subscription ID. x-ms-parameter-location: method resourceGroupName_6: in: path name: resourceGroupName required: true type: string description: The resource group of the virtual machine. x-ms-parameter-location: method moveCollectionName: in: path name: moveCollectionName description: The Move Collection Name. required: true type: string x-ms-parameter-location: method commandId: name: commandId in: path required: true type: string x-ms-parameter-location: method description: Managed Cassandra cluster command id. minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ connectionNameParameter: x-ms-parameter-location: method name: connectionName in: path required: true type: string pattern: ^[a-zA-Z0-9-]{3,64}$ maxLength: 64 minLength: 3 description: The name for the connection that is to be requested. ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string description: The name of the resource group. x-ms-parameter-location: method api-version_3: name: api-version in: query description: The API version to use for the operation. required: true type: string enum: - 2020-01-13-preview ResourceGroupNameParameter_5: name: resourceGroupName in: path required: true type: string description: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. x-ms-parameter-location: method metricsOrderBy: name: orderby in: query x-ms-parameter-location: method description: The aggregation function and direction to sort the segments by. This value is only valid when segment is specified. type: string eventsSelect: name: $select in: query x-ms-parameter-location: method description: Limits the properties to just those requested on each returned event type: string selectParameter: name: $select in: query required: false type: string description: Select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Select policyDefinitionName: name: policyDefinitionName in: path required: true type: string description: Policy definition name. pattern: ^[^<>%&:\\?/#]*$ minLength: 1 maxLength: 64 x-ms-parameter-location: method ApiVersionParameter_15: name: api-version in: query required: true type: string description: The API version to use for each request. eventsFilter: name: $filter in: query required: false x-ms-parameter-location: method description: An expression used to filter the returned events type: string filter: name: $filter in: query required: false type: string description: OData filter expression. x-ms-parameter-location: method x-ms-client-name: Filter StorageApplianceNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the storage appliance. name: storageApplianceName in: path required: true resourceCollectionName: in: path name: resourceCollectionName required: true type: string description: 'The resource collection name (ex: virtualMachines for virtual machines).' x-ms-parameter-location: method subscriptionId_6: in: path name: subscriptionId description: The Subscription ID. required: true type: string apiVersionParameter: name: api-version in: query description: API Version required: true type: string x-ms-parameter-location: client ApiVersionParameter_5: name: api-version in: query required: true type: string description: The API version to be used with the HTTP request. FederatedIdentityCredentialResourceNameParameter: name: federatedIdentityCredentialResourceName in: path description: The name of the federated identity credential resource. required: true type: string x-ms-parameter-location: method metricsInterval: name: interval in: query x-ms-parameter-location: method description: The time interval to use when retrieving metric values. This is an ISO8601 duration. If interval is omitted, the metric value is aggregated across the entire timespan. If interval is supplied, the server may adjust the interval to a more appropriate size based on the timespan used for the query. In all cases, the actual interval used for the query is included in the response. type: string format: duration ApiVersionParameter_4: name: api-version in: query required: true type: string description: The client API version. eventType: name: eventType in: path required: true x-ms-parameter-location: method description: The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. type: string enum: - $all - traces - customEvents - pageViews - browserTimings - requests - dependencies - exceptions - availabilityResults - performanceCounters - customMetrics x-ms-enum: name: EventType modelAsString: true PrivateEndpointConnectionProxyIdParameter: name: privateEndpointConnectionProxyId in: path required: true type: string description: The ID of the private endpoint connection proxy object. x-ms-parameter-location: method PrivateLinkScopeName: name: scopeName in: path required: true type: string description: The name of the Azure Arc PrivateLinkScope resource. x-ms-parameter-location: method resourceGroupNameParameter: name: resourceGroupName in: path description: Name of the resource group to which the resource belongs. required: true type: string maxLength: 90 minLength: 1 pattern: ^[-\w\._\(\)]+[^\.]$ x-ms-parameter-location: method AccountNameParameter: name: accountName in: path required: true type: string pattern: ^[a-zA-Z0-9]+$ minLength: 3 maxLength: 24 description: The name of the Batch account. x-ms-parameter-location: method clusterNameParameter: name: clusterName in: path required: true type: string x-ms-parameter-location: method description: Managed Cassandra cluster name. minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ orderByParameter: name: $orderby in: query required: false type: string description: Ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: OrderBy ActivityLogAlertNameParameter: name: activityLogAlertName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ description: The name of the Activity Log Alert rule. x-ms-parameter-location: method AzureBareMetalInstanceNameParameter: name: azureBareMetalInstanceName in: path required: true type: string description: Name of the Azure BareMetal on Azure instance. x-ms-parameter-location: method SubscriptionIdParameter_17: name: subscriptionId in: path required: true type: string description: Id of the subscription. x-ms-parameter-location: method subscriptionIdParameter: name: subscriptionId in: path description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). required: true type: string x-ms-parameter-location: client subscriptionIdRequiredPathParam: name: subscriptionId in: path description: The customer subscription identifier required: true type: string remediationNameParameter: name: remediationName in: path required: true type: string description: The name of the remediation. x-ms-parameter-location: method SubscriptionIdParameter_12: name: subscriptionId in: path required: true type: string description: The ID of the target subscription. minLength: 1 x-ms-parameter-location: method L2NetworkNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the L2 network. name: l2NetworkName in: path required: true apiVersion_2: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client subscriptionId_5: name: subscriptionId in: path required: true type: string description: Microsoft Azure subscription ID. x-ms-parameter-location: method policyEventsResourceParameter: name: policyEventsResource in: path required: true type: string enum: - default description: The name of the virtual resource under PolicyEvents resource type; only "default" is allowed. x-ms-parameter-location: method BmcKeySetNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the baseboard management controller key set. name: bmcKeySetName in: path required: true applyParameter: name: $apply in: query required: false type: string description: OData apply expression for aggregations. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Apply SubscriptionIdParameter_7: name: subscriptionId in: path required: true type: string description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. x-ms-parameter-location: client ClientRequestIdParameter: name: x-ms-client-request-id x-ms-client-name: clientRequestId in: header required: false type: string format: uuid description: A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request. x-ms-client-request-id: true x-ms-parameter-grouping: name: search-management-request-options x-ms-parameter-location: method AzureDevOpsProjectName: in: path name: azureDevOpsProjectName description: Name of the AzureDevOps Project. required: true type: string x-ms-parameter-location: method subscriptionId_2: name: subscriptionId description: Azure Subscription Id in which project was created. type: string in: path required: true apiVersionParameter_8: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client flowNameParameter: x-ms-parameter-location: method name: flowName in: path required: true type: string pattern: ^[a-zA-Z0-9-]{3,64}$ maxLength: 64 minLength: 3 description: The name for the flow that is to be onboarded. monitorId: in: path name: monitorId description: The monitor Id of the virtual machine. required: true type: string x-ms-parameter-location: method TopQueryParameter: name: $top in: query required: false type: integer format: int32 description: Number of records to return. minimum: 1 x-ms-parameter-location: method ApiVersionParameter_16: name: api-version in: query description: Client Api Version. required: true type: string default: '2015-11-01' WorkspaceNameParameter: name: workspaceName in: path required: true type: string description: The name of the quantum workspace resource. x-ms-parameter-location: method skipTokenParameter: name: $skiptoken in: query required: false type: string description: Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: SkipToken resourceName: in: path name: resourceName required: true type: string description: The name of the virtual machine. x-ms-parameter-location: method apiVersionParameter_6: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client apiVersionParameter_3: name: api-version in: query description: The API Version required: true type: string assessedMachineName: name: assessedMachineName description: Unique name of an assessed machine evaluated as part of an assessment. type: string in: path x-ms-parameter-location: method required: true subscriptionIdParameter_5: name: subscriptionId description: The unique identifier for a Microsoft Azure subscription. in: path required: true type: string eventsApply: name: $apply in: query x-ms-parameter-location: method description: An expression used for aggregation over returned events type: string RackSkuNameParameter: type: string x-ms-parameter-location: method description: The name of the rack SKU. name: rackSkuName in: path required: true 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 VolumeNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,62}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the volume. name: volumeName in: path required: true eventId: name: eventId in: path required: true x-ms-parameter-location: method description: ID of event. type: string policyTrackedResourcesResourceParameter: name: policyTrackedResourcesResource in: path required: true type: string enum: - default x-ms-enum: name: PolicyTrackedResourcesResourceType modelAsString: true description: The name of the virtual resource under PolicyTrackedResources resource type; only "default" is allowed. x-ms-parameter-location: method PrivateLinkScopeName_2: name: scopeName in: path required: true type: string description: The name of the Azure Monitor PrivateLinkScope resource. x-ms-parameter-location: method ApiVersionParameter_8: name: api-version in: query required: true type: string description: ADU schema API version. AzureDevOpsOrgName: in: path name: azureDevOpsOrgName description: Name of the AzureDevOps Org. required: true type: string x-ms-parameter-location: method MediaServicesAccountName: name: accountName in: path required: true type: string description: The Media Services account name. x-ms-parameter-location: method VirtualNetworkNameParameter: name: virtualNetworkName in: path required: true type: string description: The name of the virtual network. x-ms-parameter-location: method SubscriptionIdParameter_13: name: subscriptionId in: path required: true type: string description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. metricsAggregation: name: aggregation in: query collectionFormat: csv x-ms-parameter-location: method description: The aggregation to use when computing the metric values. To retrieve more than one aggregation at a time, separate them with a comma. If no aggregation is specified, then the default aggregation for the metric is used. type: array minItems: 1 items: type: string enum: - min - max - avg - sum - count - unique x-ms-enum: name: MetricsAggregation modelAsString: true ActionGroupNameParameter: name: actionGroupName in: path required: true type: string description: The name of the action group. x-ms-parameter-location: method ApiVersionParameter_17: name: api-version in: query description: Client Api Version. required: true type: string default: '2015-11-01' CommonParams.resourceGroupName: name: resourceGroupName in: path description: Name of the Azure resource group. required: true type: string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$ x-ms-parameter-location: client from: name: $from in: query required: false type: string format: date-time description: ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). x-ms-parameter-location: method x-ms-client-name: From ResourceGroupNameParameter_2: name: resourceGroupName in: path required: true type: string description: The name of the resource group that contains the Batch account. x-ms-parameter-location: method resourceGroupNameParameter_7: name: resourceGroupName in: path required: true type: string description: Resource group name. x-ms-parameter-location: method machineName: name: machineName description: Unique name of a machine in private datacenter. type: string in: path x-ms-parameter-location: method required: true groupName: name: groupName description: Unique name of a group within a project. type: string in: path x-ms-parameter-location: method required: true PrivateLinkScopeId: name: privateLinkScopeId in: path required: true type: string description: The id (Guid) of the Azure Arc PrivateLinkScope resource. x-ms-parameter-location: method eventsSkip: name: $skip in: query x-ms-parameter-location: method description: The number of items to skip over before returning events type: integer format: int32 policyStatesResourceParameter: name: policyStatesResource in: path required: true type: string enum: - default - latest x-ms-enum: name: PolicyStatesResource modelAsString: true description: The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s). x-ms-parameter-location: method backupNameParameter: name: backupId in: path required: true type: string x-ms-parameter-location: method description: Id of a restorable backup of a Cassandra cluster. minLength: 1 maxLength: 15 pattern: ^[0-9]+$ ResourceNameParameter_2: name: queryPackName in: path required: true type: string description: The name of the Log Analytics QueryPack resource. x-ms-parameter-location: method providerName: in: path name: providerName required: true type: string description: 'The provider name (ex: Microsoft.Compute for virtual machines).' x-ms-parameter-location: method ResourceGroupName: name: resourceGroupName in: path required: true type: string description: The name of the resource group within the Azure subscription. x-ms-parameter-location: method resourceGroupNameParameter_5: name: resourceGroupName description: Name of the resource group within the Azure subscription. in: path required: true type: string x-ms-parameter-location: method eventsTop: name: $top in: query x-ms-parameter-location: method description: The number of events to return type: integer format: int32 authorizationNamespaceParameter: name: authorizationNamespace in: path required: true type: string enum: - Microsoft.Authorization description: The namespace for Microsoft Authorization resource provider; only "Microsoft.Authorization" is allowed. x-ms-parameter-location: method SubscriptionIdParameter_3: name: subscriptionId in: path required: true type: string description: The Azure subscription Id. subscriptionIdParameter_7: name: subscriptionId in: path required: true type: string description: Microsoft Azure subscription ID. DetectorIdParameter: name: detectorId in: path required: true type: string description: The name of the detector. x-ms-parameter-location: method BareMetalMachineKeySetNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the bare metal machine key set. name: bareMetalMachineKeySetName in: path required: true forceDeallocate: name: x-ms-force-deallocate in: header required: false type: string x-ms-parameter-location: method description: Force to deallocate a cluster of Cluster Type Production. Force to deallocate a cluster of Cluster Type Production might cause data loss ClusterNameParameter_2: name: clusterName in: path required: true type: string description: The name of the HDInsight cluster. x-ms-parameter-location: method CloudServicesNetworkNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the cloud services network. name: cloudServicesNetworkName in: path required: true SubscriptionIdParameter_2: name: subscriptionId in: path required: true type: string description: The Azure subscription ID. ServiceNameRequiredPathParam: name: serviceName in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: The identity of the service. resourceNameParameter: name: botName x-ms-parameter-location: method in: path required: true type: string maxLength: 64 minLength: 2 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ description: The name of the Bot resource. CommonParams.subscriptionId: name: subscriptionId in: path description: The Azure subscription ID. required: true type: string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ x-ms-parameter-location: client workspaceNameParameter_2: name: workspaceName in: path required: true type: string description: The name of the workspace x-ms-parameter-location: method GitHubConnectorName: in: path name: gitHubConnectorName description: Name of the GitHub Connector. required: true type: string x-ms-parameter-location: method SubscriptionIdParameter_11: name: subscriptionId in: path required: true type: string description: The subscription ID that identifies an Azure subscription. resourceGroupNameParameter_6: name: resourceGroupName in: path required: true type: string description: Resource group name. x-ms-parameter-location: method SubscriptionIdParameter_5: name: subscriptionId in: path required: true type: string description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) SubscriptionIdParameter_18: name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call. required: true type: string ConsoleNameParameter: pattern: ^default$ type: string x-ms-parameter-location: method description: The name of the virtual machine console. name: consoleName in: path required: true heartbeatFilter: name: $filter in: query description: 'Optionally filter by heartbeat condition. Example: $filter=isHeartbeat eq false.' required: false type: string x-ms-parameter-location: method ExtensionTypeNameParameter: name: extensionTypeName in: path required: true type: string description: Extension type name x-ms-parameter-location: method policyAssignmentNameParameter: name: policyAssignmentName in: path required: true type: string description: Policy assignment name. x-ms-parameter-location: method MetricsConfigurationName: pattern: ^default$ type: string x-ms-parameter-location: method description: The name of the metrics configuration for the cluster. name: metricsConfigurationName in: path required: true TargetSubscriptionIdParameter: description: The target subscription ID. name: targetSubscriptionId in: path type: string required: true x-ms-parameter-location: method resourceGroupName: name: resourceGroupName description: The name of the resource group to get. The name is case insensitive. in: path required: true type: string pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 x-ms-parameter-location: method ResourceGroupNameParameter_3: name: resourceGroupName in: path required: true type: string description: The resource group name. x-ms-parameter-location: method resourceGroupNameParameter_8: name: resourceGroupName in: path required: true type: string description: Resource group name. x-ms-parameter-location: method mediaResourceNameParameter: name: mediaServiceName description: Name of the Media Service. in: path required: true type: string pattern: ^[a-z0-9]{3,24}$ minLength: 3 maxLength: 24 x-ms-parameter-location: method ComponentPurgeParameter: name: body in: body description: Describes the body of a request to purge data in a single table of an Application Insights component required: true schema: $ref: '#/definitions/ComponentPurgeBody' x-ms-parameter-location: method SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ResourceNameParameter: name: resourceName in: path required: true type: string description: The name of the Application Insights component resource. x-ms-parameter-location: method resourceGroupName_2: name: resourceGroupName description: Name of the Azure Resource Group that project is part of. type: string in: path x-ms-parameter-location: method required: true ClusterNameParameter: name: clusterName in: path required: true type: string description: The name of the cluster. x-ms-parameter-location: method SubscriptionIdParameter_10: name: subscriptionId in: path description: The Id of the Subscription to which the identity belongs. required: true type: string ApiVersionParameter_9: name: api-version in: query required: true type: string description: Client API Version. ApplicationNameRequiredPathParam: name: applicationName in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: The identity of the application. FilterParameter_2: description: OData filter parameter. name: $filter in: query type: string x-ms-parameter-location: method resourceGroupNameParameter_10: name: resourceGroupName in: path required: true type: string description: Resource group name. x-ms-parameter-location: method TrunkedNetworkNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the trunked network. name: trunkedNetworkName in: path required: true toParameter: name: $to in: query required: false type: string format: date-time description: ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: To apiVersion: name: apiVersion description: Client API version. in: query required: true type: string x-ms-parameter-location: method ClusterPoolNameParameter: name: clusterPoolName in: path required: true type: string description: The name of the cluster pool. x-ms-parameter-location: method fromParameter: name: $from in: query required: false type: string format: date-time description: ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: From queryTimespan: name: timespan in: query required: false x-ms-parameter-location: method description: Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression. type: string cloudHsmClusterName: name: cloudHsmClusterName in: path required: true type: string description: The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 24 characters in length. pattern: ^[a-zA-Z0-9-]{3,24}$ maxLength: 24 minLength: 3 x-ms-parameter-location: method RackNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the rack. name: rackName in: path required: true ResourceGroupNameParameter_4: 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 ApiVersionParameter_12: name: api-version in: query required: true type: string description: Client Api Version. componentPolicyStatesResource: name: componentPolicyStatesResource in: path required: true type: string enum: - latest x-ms-enum: name: ComponentPolicyStatesResource modelAsString: true description: The virtual resource under ComponentPolicyStates resource type. In a given time range, 'latest' represents the latest component policy state(s). x-ms-parameter-location: method acceptLanguage: description: Standard request header. Used by service to respond to client in appropriate language. name: Accept-Language type: string in: header x-ms-parameter-location: client SubscriptionIdParameter_9: name: subscriptionId in: path required: true type: string description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. NotificationIdParameter: name: notificationId in: path required: true type: string description: The notification id x-ms-parameter-location: method subscriptionIdParameter_2: name: subscriptionId in: path description: Azure Subscription ID. required: true type: string SubscriptionIdParameter_8: name: subscriptionId in: path required: true type: string description: The Azure subscription ID. ClusterNameParameter_3: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the cluster. name: clusterName in: path required: true SubscriptionIdParameter_6: name: subscriptionId in: path required: true type: string description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ApiVersionParameter_14: name: api-version in: query required: true type: string description: The API version to use for this operation. projectName: name: projectName description: Name of the Azure Migrate project. type: string in: path x-ms-parameter-location: method required: true eventsTimespan: name: timespan in: query required: false x-ms-parameter-location: method description: Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression. type: string apiVersionParameter_7: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client subscriptionId: name: subscriptionId description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. in: path required: true type: string x-ms-parameter-location: method metricsTop: name: top in: query x-ms-parameter-location: method description: The number of segments to return. This value is only valid when segment is specified. type: integer format: int32 ResourceNameParameter_4: name: resourceName in: path description: The name of the identity resource. required: true type: string x-ms-parameter-location: method hostnameParameter: name: hostname in: query description: Specific hostname required: false type: string x-ms-parameter-location: method AgentPoolNameParameter: pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ type: string x-ms-parameter-location: method description: The name of the Kubernetes cluster agent pool. name: agentPoolName in: path required: true topParameter: name: $top in: query required: false type: integer format: int32 minimum: 0 description: Maximum number of records to return. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Top PlansParameter: name: planId in: path required: true type: string x-ms-parameter-location: method description: Plan identifier string of image being deployed. ApiVersionParameter_7: name: api-version in: query required: true type: string description: Client API version x-ms-parameter-location: client eventsCount: name: $count in: query x-ms-parameter-location: method description: Request a count of matching items included with the returned events type: boolean LocationParameter: name: locationName in: path required: true type: string description: Location. x-ms-parameter-location: method ApiVersionParameter_2: name: api-version in: query required: true type: string description: Client Api Version. ApiVersionParameter_11: name: api-version in: query required: true type: string description: The API version to use for the request. api-versionRequiredQueryParam: name: api-version in: query type: string enum: - 2018-07-01-preview default: 2018-07-01-preview description: The version of the API. This parameter is required and its value must be `2018-07-01-preview`. required: true x-ms-enum: name: 2018-07-01-preview modelAsString: true values: - value: 2018-07-01-preview description: The `2018-07-01-preview` version of the API. CheckNameAvailabilityParameter: description: Check name availability parameter name: nameAvailabilityDefinition in: body schema: $ref: '#/definitions/CheckNameAvailabilityDefinition' required: true x-ms-parameter-location: method UpdateNameParameter: name: updateName in: path required: true type: string description: The name of the Update x-ms-parameter-location: method timestampUnix: in: path name: timestampUnix description: The timestamp of the state change (unix format). required: true type: string x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'