swagger: "2.0"
schemes:
  - https
host: management.azure.com
info:
  description: Use these REST APIs to manage Azure API Management deployment.
  title: ApiManagementClient
  version: 2019-01-01
  x-apisguru-categories:
    - cloud
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
  x-origin:
    - format: swagger
      url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimdeployment.json
      version: "2.0"
  x-preferred: true
  x-providerName: azure.com
  x-serviceName: apimanagement-apimdeployment
  x-tags:
    - Azure
    - Microsoft
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  azure_auth:
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    description: Azure Active Directory OAuth2 Flow.
    flow: implicit
    scopes:
      user_impersonation: impersonate your user account
    type: oauth2
security:
  - azure_auth:
      - user_impersonation
parameters: {}
paths:
  /providers/Microsoft.ApiManagement/operations:
    get:
      description: Lists all of the available REST API operations of the Microsoft.ApiManagement provider.
      operationId: ApiManagementOperations_List
      parameters:
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          required: true
          type: string
      responses:
        "200":
          description: Success. The response describes the list of operations.
          schema:
            $ref: "#/definitions/OperationListResult"
      tags:
        - ApiManagementOperations
      x-ms-examples:
        ApiManagementListOperations:
          parameters:
            api-version: 2019-01-01
          responses:
            "200":
              body:
                value:
                  - display:
                      description: Create a new instance of API Management Service
                      operation: Create a new instance of API Management Service
                      provider: Microsoft API Management
                      resource: Service
                    name: Microsoft.ApiManagement/service/write
                  - display:
                      description: Read metadata for an API Management Service instance
                      operation: Read metadata for an API Management Service instance
                      provider: Microsoft API Management
                      resource: Service
                    name: Microsoft.ApiManagement/service/read
                  - display:
                      description: Delete API Management Service instance
                      operation: Delete API Management Service instance
                      provider: Microsoft API Management
                      resource: Service
                    name: Microsoft.ApiManagement/service/delete
                  - display:
                      description: Creates or updates the diagnostic setting for API Management service
                      operation: Write diagnostic setting
                      provider: Microsoft API Management
                      resource: Service
                    name: Microsoft.ApiManagement/service/providers/Microsoft.Insights/diagnosticSettings/write
                    origin: system
                  - display:
                      description: Get list of operation results or Get result of a specific operation
                      operation: Get operation results or Get operation result
                      provider: Microsoft API Management
                      resource: Results of async operations
                    name: Microsoft.ApiManagement/service/tenant/operationResults/read
      x-ms-pageable:
        nextLinkName: nextLink
  "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability":
    post:
      description: Checks availability and correctness of a name for an API Management service.
      operationId: ApiManagementService_CheckNameAvailability
      parameters:
        - description: Parameters supplied to the CheckNameAvailability operation.
          in: body
          name: parameters
          required: true
          schema:
            $ref: "#/definitions/ApiManagementServiceCheckNameAvailabilityParameters"
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: The result of check name availability.
          schema:
            $ref: "#/definitions/ApiManagementServiceNameAvailabilityResult"
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementServiceCheckNameAvailability:
          parameters:
            api-version: 2019-01-01
            parameters:
              name: apimService1
            resourceGroupName: rg1
            subscriptionId: subid
          responses:
            "200":
              body:
                message: ""
                nameAvailable: true
                reason: Valid
  "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/service":
    get:
      description: Lists all API Management services within an Azure subscription.
      operationId: ApiManagementService_List
      parameters:
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: The API Management service list.
          schema:
            $ref: "#/definitions/ApiManagementServiceListResult"
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementListServiceBySubscription:
          parameters:
            api-version: 2019-01-01
            subscriptionId: subid
          responses:
            "200":
              body:
                value:
                  - etag: AAAAAAAXXAQ=
                    id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3
                    location: West US
                    name: apimService3
                    properties:
                      additionalLocations:
                        - location: West Europe
                          publicIPAddresses:
                            - 52.233.184.197
                          sku:
                            capacity: 1
                            name: Premium
                      createdAtUtc: 2017-05-27T15:33:55.5426123Z
                      gatewayUrl: https://apimService3.azure-api.net
                      hostnameConfigurations: []
                      managementApiUrl: https://apimService3.management.azure-api.net
                      notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                      portalUrl: https://apimService3.portal.azure-api.net
                      provisioningState: Succeeded
                      publicIPAddresses:
                        - 13.88.16.64
                      publisherEmail: admin@live.com
                      publisherName: contoso
                      scmUrl: https://apimService3.scm.azure-api.net
                      targetProvisioningState: ""
                      virtualNetworkType: None
                    sku:
                      capacity: 1
                      name: Premium
                    tags: {}
                    type: Microsoft.ApiManagement/service
                  - etag: AAAAAAAXW4U=
                    id: /subscriptions/subid/resourceGroups/rg2/providers/Microsoft.ApiManagement/service/apimService2
                    location: West US
                    name: apimService2
                    properties:
                      createdAtUtc: 2017-05-26T23:55:31.1405115Z
                      gatewayUrl: https://apimService2.azure-api.net
                      hostnameConfigurations: []
                      managementApiUrl: https://apimService2.management.azure-api.net
                      notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                      portalUrl: https://apimService2.portal.azure-api.net
                      provisioningState: Succeeded
                      publicIPAddresses:
                        - 13.64.237.151
                      publisherEmail: admin@live.com
                      publisherName: MS
                      scmUrl: https://apimService2.scm.azure-api.net
                      targetProvisioningState: ""
                      virtualNetworkType: None
                    sku:
                      capacity: 1
                      name: Developer
                    tags: {}
                    type: Microsoft.ApiManagement/service
                  - etag: AAAAAAAXW5c=
                    id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService5
                    location: West US
                    name: apimService5
                    properties:
                      createdAtUtc: 2017-05-26T18:13:02.0196315Z
                      gatewayUrl: https://apimService5.azure-api.net
                      hostnameConfigurations:
                        - certificate:
                            expiry: 2018-03-17T21:55:07+00:00
                            subject: CN=proxytemplatehostname1.contoso.com
                            thumbprint: DE57B67BA63D21E925DA8BEFA436E6B7553A4C19
                          hostName: proxytemplatehostname1.contoso.com
                          negotiateClientCertificate: false
                          type: Proxy
                        - certificate:
                            expiry: 2018-03-17T21:55:07+00:00
                            subject: CN=proxytemplatehostname2.contoso.com
                            thumbprint: DE57B67BA63D21E925DA8BEFA436E6B7553A4C19
                          hostName: proxytemplatehostname2.contoso.com
                          negotiateClientCertificate: true
                          type: Proxy
                        - certificate:
                            expiry: 2018-03-17T21:55:07+00:00
                            subject: CN=proxytemplatehostname3.contoso.com
                            thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                          hostName: proxytemplatehostname3.azure-api.net
                          negotiateClientCertificate: false
                          type: Proxy
                        - certificate:
                            expiry: 2018-03-17T21:55:07+00:00
                            subject: CN=proxytemplatehostname4.contoso.com
                            thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                          hostName: proxytemplatehostname4.azure-api.net
                          negotiateClientCertificate: true
                          type: Proxy
                        - certificate:
                            expiry: 2018-03-17T21:55:07+00:00
                            subject: CN=portaltemplatehostname1.contoso.com
                            thumbprint: DE57B67BA63D21E925DA8BEFA436E6B7553A4C19
                          hostName: portaltemplatehostname1.contoso.com
                          negotiateClientCertificate: false
                          type: Portal
                      managementApiUrl: https://apimService5.management.azure-api.net
                      notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                      portalUrl: https://apimService5.portal.azure-api.net
                      provisioningState: Succeeded
                      publicIPAddresses:
                        - 13.93.167.166
                      publisherEmail: admin@live.com
                      publisherName: contoso
                      scmUrl: https://apimService5.scm.azure-api.net
                      targetProvisioningState: ""
                      virtualNetworkType: None
                    sku:
                      capacity: 1
                      name: Premium
                    tags: {}
                    type: Microsoft.ApiManagement/service
      x-ms-pageable:
        nextLinkName: nextLink
  "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service":
    get:
      description: List all API Management services within a resource group.
      operationId: ApiManagementService_ListByResourceGroup
      parameters:
        - description: The name of the resource group.
          in: path
          name: resourceGroupName
          required: true
          type: string
          x-ms-parameter-location: method
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: The API Management service list.
          schema:
            $ref: "#/definitions/ApiManagementServiceListResult"
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementListServiceBySubscriptionAndResourceGroup:
          parameters:
            api-version: 2019-01-01
            resourceGroupName: rg1
            subscriptionId: subid
          responses:
            "200":
              body:
                value:
                  - etag: AAAAAAAXXAQ=
                    id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3
                    location: West US
                    name: apimService3
                    properties:
                      additionalLocations:
                        - location: West Europe
                          publicIPAddresses:
                            - 52.233.184.197
                          sku:
                            capacity: 1
                            name: Premium
                      createdAtUtc: 2017-05-27T15:33:55.5426123Z
                      gatewayUrl: https://apimService3.azure-api.net
                      hostnameConfigurations: []
                      managementApiUrl: https://apimService3.management.azure-api.net
                      portalUrl: https://apimService3.portal.azure-api.net
                      provisioningState: Succeeded
                      publicIPAddresses:
                        - 13.88.16.64
                      publisherEmail: admin@live.com
                      publisherName: contoso
                      scmUrl: https://apimService3.scm.azure-api.net
                      targetProvisioningState: ""
                      virtualNetworkType: None
                    sku:
                      capacity: 1
                      name: Premium
                    tags: {}
                    type: Microsoft.ApiManagement/service
                  - etag: AAAAAAAXW4U=
                    id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService2
                    location: West US
                    name: apimService2
                    properties:
                      createdAtUtc: 2017-05-26T23:55:31.1405115Z
                      gatewayUrl: https://apimService2.azure-api.net
                      hostnameConfigurations: []
                      managementApiUrl: https://apimService2.management.azure-api.net
                      portalUrl: https://apimService2.portal.azure-api.net
                      provisioningState: Succeeded
                      publicIPAddresses:
                        - 13.64.237.151
                      publisherEmail: admin@live.com
                      publisherName: MS
                      scmUrl: https://apimService2.scm.azure-api.net
                      targetProvisioningState: ""
                      virtualNetworkType: None
                    sku:
                      capacity: 1
                      name: Developer
                    tags: {}
                    type: Microsoft.ApiManagement/service
                  - etag: AAAAAAAXW5c=
                    id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService5
                    location: West US
                    name: apimService5
                    properties:
                      createdAtUtc: 2017-05-26T18:13:02.0196315Z
                      gatewayUrl: https://apimService5.azure-api.net
                      hostnameConfigurations:
                        - certificate:
                            expiry: 2018-03-17T21:55:07+00:00
                            subject: CN=proxytemplatehostname1.contoso.com
                            thumbprint: DE57B67BA63D21E925DA8BEFA436E6B7553A4C19
                          hostName: proxytemplatehostname1.contoso.com
                          negotiateClientCertificate: false
                          type: Proxy
                        - certificate:
                            expiry: 2018-03-17T21:55:07+00:00
                            subject: CN=proxytemplatehostname2.contoso.com
                            thumbprint: DE57B67BA63D21E925DA8BEFA436E6B7553A4C19
                          hostName: proxytemplatehostname2.contoso.com
                          negotiateClientCertificate: true
                          type: Proxy
                        - certificate:
                            expiry: 2018-03-17T21:55:07+00:00
                            subject: CN=proxytemplatehostname3.contoso.com
                            thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                          hostName: proxytemplatehostname3.azure-api.net
                          negotiateClientCertificate: false
                          type: Proxy
                        - certificate:
                            expiry: 2018-03-17T21:55:07+00:00
                            subject: CN=proxytemplatehostname4.contoso.com
                            thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                          hostName: proxytemplatehostname4.azure-api.net
                          negotiateClientCertificate: true
                          type: Proxy
                        - certificate:
                            expiry: 2018-03-17T21:55:07+00:00
                            subject: CN=portaltemplatehostname1.contoso.com
                            thumbprint: DE57B67BA63D21E925DA8BEFA436E6B7553A4C19
                          hostName: portaltemplatehostname1.contoso.com
                          negotiateClientCertificate: false
                          type: Portal
                      managementApiUrl: https://apimService5.management.azure-api.net
                      portalUrl: https://apimService5.portal.azure-api.net
                      provisioningState: Succeeded
                      publicIPAddresses:
                        - 13.93.167.166
                      publisherEmail: admin@live.com
                      publisherName: contoso
                      scmUrl: https://apimService5.scm.azure-api.net
                      targetProvisioningState: ""
                      virtualNetworkType: None
                    sku:
                      capacity: 1
                      name: Premium
                    tags: {}
                    type: Microsoft.ApiManagement/service
      x-ms-pageable:
        nextLinkName: nextLink
  "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}":
    delete:
      description: Deletes an existing API Management service.
      operationId: ApiManagementService_Delete
      parameters:
        - description: The name of the resource group.
          in: path
          name: resourceGroupName
          required: true
          type: string
          x-ms-parameter-location: method
        - description: The name of the API Management service.
          in: path
          maxLength: 50
          minLength: 1
          name: serviceName
          pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
          required: true
          type: string
          x-ms-parameter-location: method
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: Service was successfully deleted.
        "202":
          description: The service delete request was Accepted.
          schema:
            $ref: "#/definitions/ApiManagementServiceResource"
        "204":
          description: The service does not exist.
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementServiceDeleteService:
          parameters:
            api-version: 2019-01-01
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200": {}
            "202":
              body:
                etag: AAAAAAFfhHY=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: West US
                name: apimService1
                properties:
                  createdAtUtc: 2016-12-20T19:41:21.5823069Z
                  customProperties:
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10: "True"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11: "True"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168: "True"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "True"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11: "True"
                  gatewayRegionalUrl: https://apimService1-westus-01.regional.azure-api.net
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations: []
                  managementApiUrl: https://apimService1.management.azure-api.net
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  portalUrl: https://apimService1.portal.azure-api.net
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 40.XX.XXX.168
                  publisherEmail: sasolank@microsoft.com
                  publisherName: Microsoft
                  scmUrl: https://apimService1.scm.azure-api.net
                  targetProvisioningState: Deleting
                  virtualNetworkConfiguration:
                    subnetResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/BlockVNETSamir/subnets/default
                  virtualNetworkType: External
                sku:
                  capacity: 1
                  name: Developer
                tags: {}
                type: Microsoft.ApiManagement/service
              headers:
                location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2019-01-01
            "204": {}
      x-ms-long-running-operation: true
    get:
      description: Gets an API Management service resource description.
      operationId: ApiManagementService_Get
      parameters:
        - description: The name of the resource group.
          in: path
          name: resourceGroupName
          required: true
          type: string
          x-ms-parameter-location: method
        - description: The name of the API Management service.
          in: path
          maxLength: 50
          minLength: 1
          name: serviceName
          pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
          required: true
          type: string
          x-ms-parameter-location: method
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: Successfully got the API Management Service Resource.
          schema:
            $ref: "#/definitions/ApiManagementServiceResource"
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementServiceGetMultiRegionInternalVnet:
          parameters:
            api-version: 2019-01-01
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAADqC0c=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1
                location: West US
                name: apimservice1
                properties:
                  additionalLocations:
                    - gatewayRegionalUrl: https://apimservice1-westus2-01.regional.azure-api.net
                      location: West US 2
                      privateIPAddresses:
                        - 10.0.X.6
                      publicIPAddresses:
                        - 40.XXX.79.187
                      sku:
                        capacity: 1
                        name: Premium
                      virtualNetworkConfiguration:
                        subnetResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub
                  createdAtUtc: 2018-02-02T01:42:09.1268424Z
                  customProperties:
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10: "True"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11: "True"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168: "True"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "True"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11: "True"
                  gatewayRegionalUrl: https://apimservice1-westus-01.regional.azure-api.net
                  gatewayUrl: https://apimservice1.azure-api.net
                  hostnameConfigurations:
                    - certificate:
                        expiry: 2019-08-16T16:51:34+00:00
                        subject: CN=*.preview.net
                        thumbprint: B4330123DBAXXXXXXXXX1F35E84493476
                      defaultSslBinding: true
                      hostName: apimgatewaytest.preview.net
                      negotiateClientCertificate: false
                      type: Proxy
                  managementApiUrl: https://apimservice1.management.azure-api.net
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  portalUrl: https://apimservice1.portal.azure-api.net
                  privateIPAddresses:
                    - 172.XX.0.5
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 137.XXX.11.74
                  publisherEmail: abcs@contoso.com
                  publisherName: contoso publisher
                  scmUrl: https://apimservice1.scm.azure-api.net
                  targetProvisioningState: ""
                  virtualNetworkConfiguration:
                    subnetResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet
                  virtualNetworkType: Internal
                sku:
                  capacity: 1
                  name: Premium
                tags: {}
                type: Microsoft.ApiManagement/service
        ApiManagementServiceGetService:
          parameters:
            api-version: 2019-01-01
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAAYP5M=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: Central US
                name: apimService1
                properties:
                  additionalLocations:
                    - gatewayRegionalUrl: https://apimService1-westus-01.regional.azure-api.net
                      location: West US
                      publicIPAddresses:
                        - 40.78.99.244
                      sku:
                        capacity: 1
                        name: Premium
                  createdAtUtc: 2017-06-28T23:01:33.0667959Z
                  gatewayRegionalUrl: https://apimService1-centralus-01.regional.azure-api.net
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations:
                    - certificate:
                        expiry: 2018-03-17T21:55:07+00:00
                        subject: CN=*.contoso.net
                        thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                      defaultSslBinding: true
                      hostName: proxyhostname4.contoso.net
                      negotiateClientCertificate: false
                      type: Proxy
                    - certificate:
                        expiry: 2018-03-17T21:55:07+00:00
                        subject: CN=*.contoso.net
                        thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                      defaultSslBinding: true
                      hostName: proxyhostname9.contoso.net
                      negotiateClientCertificate: false
                      type: Proxy
                    - certificate:
                        expiry: 2018-03-17T21:55:07+00:00
                        subject: CN=*.contoso.net
                        thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                      defaultSslBinding: false
                      hostName: portalhostname2.contoso.net
                      negotiateClientCertificate: false
                      type: Portal
                  managementApiUrl: https://apimService1.management.azure-api.net
                  notificationSenderEmail: contoso@live.com
                  portalUrl: https://apimService1.portal.azure-api.net
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 52.173.22.222
                  publisherEmail: contoso@microsoft.com
                  publisherName: admin
                  scmUrl: https://apimService1.scm.azure-api.net
                  targetProvisioningState: ""
                  virtualNetworkType: None
                sku:
                  capacity: 1
                  name: Premium
                tags: {}
                type: Microsoft.ApiManagement/service
        ApiManagementServiceGetServiceHavingMsi:
          parameters:
            api-version: 2019-01-01
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAC2jkE=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                identity:
                  principalId: ae7d906a-xxx-408a-xxxx-6b9d60e5756b
                  tenantId: 72f988bf-xxx-41af-xxxx-2d7cd011db47
                  type: SystemAssigned
                location: West US
                name: apimService1
                properties:
                  createdAtUtc: 2017-10-13T16:56:47.0174063Z
                  gatewayRegionalUrl: https://apimService1-westus-01.regional.azure-api.net
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations:
                    - certificate:
                        expiry: 2036-01-01T07:00:00+00:00
                        subject: CN=*.msitesting.net
                        thumbprint: 8E98XXX52CAXXXXXXX2C91F1D174FDB3A2
                      defaultSslBinding: true
                      hostName: foobar.msitesting.net
                      keyVaultId: https://constoso-msi-keyvault.vault.azure.net/secrets/msitestingCert
                      negotiateClientCertificate: false
                      type: Proxy
                  managementApiUrl: https://apimService1.management.azure-api.net
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  portalUrl: https://apimService1.portal.azure-api.net
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 13.xx.76.xxx
                  publisherEmail: admin@contoso.com
                  publisherName: Contoso
                  scmUrl: https://apimService1.scm.azure-api.net
                sku:
                  capacity: 1
                  name: Developer
                tags: {}
                type: Microsoft.ApiManagement/service
    patch:
      description: Updates an existing API Management service.
      operationId: ApiManagementService_Update
      parameters:
        - description: The name of the resource group.
          in: path
          name: resourceGroupName
          required: true
          type: string
          x-ms-parameter-location: method
        - description: The name of the API Management service.
          in: path
          maxLength: 50
          minLength: 1
          name: serviceName
          pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
          required: true
          type: string
          x-ms-parameter-location: method
        - description: Parameters supplied to the CreateOrUpdate API Management service operation.
          in: body
          name: parameters
          required: true
          schema:
            $ref: "#/definitions/ApiManagementServiceUpdateParameters"
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: The service was successfully updated.
          schema:
            $ref: "#/definitions/ApiManagementServiceResource"
        "202":
          description: The service update request was Accepted.
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementUpdateServiceDisableTls10:
          parameters:
            api-version: 2019-01-01
            parameters:
              properties:
                customProperties:
                  Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "false"
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAAYRPs=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: West US
                name: apimService1
                properties:
                  createdAtUtc: 2017-06-29T17:50:42.3191122Z
                  customProperties:
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "False"
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations: []
                  managementApiUrl: https://apimService1.management.azure-api.net
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  portalUrl: https://apimService1.portal.azure-api.net
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 40.86.176.232
                  publisherEmail: admin@live.com
                  publisherName: Contoso
                  scmUrl: https://apimService1.scm.azure-api.net
                  targetProvisioningState: ""
                  virtualNetworkType: None
                sku:
                  capacity: 1
                  name: Standard
                tags:
                  Owner: sasolank
                  Pool: Manual
                  Reserved: ""
                  TestExpiration: Thu, 29 Jun 2017 18:50:40 GMT
                  TestSuiteExpiration: Thu, 29 Jun 2017 18:51:46 GMT
                  UID: 4f5025fe-0669-4e2e-8320-5199466e5eb3
                type: Microsoft.ApiManagement/service
            "202":
              etag: AAAAAAAYRPs=
              id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
              location: West US
              name: apimService1
              properties:
                createdAtUtc: 2017-06-29T17:50:42.3191122Z
                customProperties:
                  Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "False"
                gatewayUrl: https://apimService1.azure-api.net
                hostnameConfigurations: []
                managementApiUrl: https://apimService1.management.azure-api.net
                notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                portalUrl: https://apimService1.portal.azure-api.net
                provisioningState: Succeeded
                publicIPAddresses:
                  - 40.86.176.232
                publisherEmail: admin@live.com
                publisherName: Contoso
                scmUrl: https://apimService1.scm.azure-api.net
                targetProvisioningState: ""
                virtualNetworkType: None
              sku:
                capacity: 1
                name: Standard
              tags:
                TestExpiration: Thu, 29 Jun 2017 18:50:40 GMT
              type: Microsoft.ApiManagement/service
        ApiManagementUpdateServicePublisherDetails:
          parameters:
            api-version: 2019-01-01
            parameters:
              properties:
                publisherEmail: foobar@live.com
                publisherName: Contoso Vnext
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAAYRPs=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: West US
                name: apimService1
                properties:
                  createdAtUtc: 2017-06-29T17:50:42.3191122Z
                  customProperties:
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "False"
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations: []
                  managementApiUrl: https://apimService1.management.azure-api.net
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  portalUrl: https://apimService1.portal.azure-api.net
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 40.86.176.232
                  publisherEmail: foobar@live.com
                  publisherName: Contoso Vnext
                  scmUrl: https://apimService1.scm.azure-api.net
                  targetProvisioningState: ""
                  virtualNetworkType: None
                sku:
                  capacity: 1
                  name: Standard
                tags:
                  Owner: sasolank
                  Pool: Manual
                  Reserved: ""
                  TestExpiration: Thu, 29 Jun 2017 18:50:40 GMT
                  TestSuiteExpiration: Thu, 29 Jun 2017 18:51:46 GMT
                  UID: 4f5025fe-0669-4e2e-8320-5199466e5eb3
                type: Microsoft.ApiManagement/service
            "202":
              etag: AAAAAAAYRPs=
              id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
              location: West US
              name: apimService1
              properties:
                createdAtUtc: 2017-06-29T17:50:42.3191122Z
                customProperties:
                  Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "False"
                gatewayUrl: https://apimService1.azure-api.net
                hostnameConfigurations: []
                managementApiUrl: https://apimService1.management.azure-api.net
                notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                portalUrl: https://apimService1.portal.azure-api.net
                provisioningState: Succeeded
                publicIPAddresses:
                  - 40.86.176.232
                publisherEmail: admin@live.com
                publisherName: Contoso
                scmUrl: https://apimService1.scm.azure-api.net
                targetProvisioningState: ""
                virtualNetworkType: None
              sku:
                capacity: 1
                name: Standard
              tags:
                TestExpiration: Thu, 29 Jun 2017 18:50:40 GMT
              type: Microsoft.ApiManagement/service
      x-ms-long-running-operation: true
    put:
      description: Creates or updates an API Management service. This is long running operation and could take several minutes to complete.
      operationId: ApiManagementService_CreateOrUpdate
      parameters:
        - description: The name of the resource group.
          in: path
          name: resourceGroupName
          required: true
          type: string
          x-ms-parameter-location: method
        - description: The name of the API Management service.
          in: path
          maxLength: 50
          minLength: 1
          name: serviceName
          pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
          required: true
          type: string
          x-ms-parameter-location: method
        - description: Parameters supplied to the CreateOrUpdate API Management service operation.
          in: body
          name: parameters
          required: true
          schema:
            $ref: "#/definitions/ApiManagementServiceResource"
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: The service was successfully set up.
          schema:
            $ref: "#/definitions/ApiManagementServiceResource"
        "201":
          description: Created
          schema:
            $ref: "#/definitions/ApiManagementServiceResource"
        "202":
          description: Accepted the configuration change when updating the service.
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementCreateMultiRegionServiceWithCustomHostname:
          parameters:
            api-version: 2019-01-01
            parameters:
              location: Central US
              properties:
                additionalLocations:
                  - location: North Europe
                    sku:
                      capacity: 1
                      name: Premium
                    virtualNetworkConfiguration:
                      subnetResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/apimSubnet
                hostnameConfigurations:
                  - certificatePassword: "**************Password of the Certificate************************************************"
                    encodedCertificate: "************Base 64 Encoded Pfx Certificate************************"
                    hostName: proxyhostname1.contoso.com
                    type: Proxy
                  - certificatePassword: "**************Password of the Certificate************************************************"
                    encodedCertificate: "************Base 64 Encoded Pfx Certificate************************"
                    hostName: proxyhostname2.contoso.com
                    negotiateClientCertificate: true
                    type: Proxy
                  - certificatePassword: "**************Password of the Certificate************************************************"
                    encodedCertificate: "************Base 64 Encoded Pfx Certificate************************"
                    hostName: portalhostname1.contoso.com
                    type: Portal
                publisherEmail: admin@live.com
                publisherName: contoso
                virtualNetworkConfiguration:
                  subnetResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/centralUsVirtualNetwork/subnets/apimSubnet
                virtualNetworkType: External
              sku:
                capacity: 1
                name: Premium
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAFzTM0=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: Central US
                name: apimService1
                properties:
                  additionalLocations:
                    - gatewayRegionalUrl: https://apimService1-northeurope-01.regional.azure-api.net
                      location: North Europe
                      publicIPAddresses:
                        - 52.XXX.197.222
                      sku:
                        capacity: 1
                        name: Premium
                      virtualNetworkConfiguration:
                        subnetResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/apimSubnet
                  createdAtUtc: 2019-04-11T08:25:38.5086594Z
                  customProperties:
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11: "False"
                  gatewayRegionalUrl: https://apimService1-centralus-01.regional.azure-api.net
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations:
                    - defaultSslBinding: true
                      hostName: apimService1.azure-api.net
                      negotiateClientCertificate: false
                      type: Proxy
                    - certificate:
                        expiry: 2018-03-17T21:55:07+00:00
                        subject: CN=proxyhostname1.contoso.com
                        thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                      hostName: proxyhostname1.contoso.com
                      negotiateClientCertificate: false
                      type: Proxy
                    - certificate:
                        expiry: 2018-03-17T21:55:07+00:00
                        subject: CN=proxyhostname2.contoso.com
                        thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                      hostName: proxyhostname2.contoso.com
                      negotiateClientCertificate: true
                      type: Proxy
                    - certificate:
                        expiry: 2018-03-17T21:55:07+00:00
                        subject: CN=portalhostname1.contoso.com
                        thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                      hostName: portalhostname1.contoso.com
                      negotiateClientCertificate: false
                      type: Portal
                  managementApiUrl: https://apimService1.management.azure-api.net
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  portalUrl: https://apimService1.portal.azure-api.net
                  privateIPAddresses: null
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 104.43.XXX.72
                  publisherEmail: admin@live.com
                  publisherName: contoso
                  scmUrl: https://apimService1.scm.azure-api.net
                  targetProvisioningState: ""
                  virtualNetworkConfiguration:
                    subnetResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/centralUsVirtualNetwork/subnets/apimSubnet
                  virtualNetworkType: External
                sku:
                  capacity: 1
                  name: Premium
                tags:
                  tag1: value1
                  tag2: value2
                  tag3: value3
                type: Microsoft.ApiManagement/service
            "201":
              body:
                etag: AAAAAAAXXpw=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: Central US
                name: apimService1
                properties:
                  additionalLocations:
                    - location: North Europe
                      publicIPAddresses: []
                      sku:
                        capacity: 1
                        name: Premium
                      virtualNetworkConfiguration:
                        subnetResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/apimSubnet
                  createdAtUtc: 2019-04-11T08:25:38.5086594Z
                  hostnameConfigurations:
                    - defaultSslBinding: true
                      hostName: apimService1.azure-api.net
                      negotiateClientCertificate: false
                      type: Proxy
                    - certificate:
                        expiry: 2018-03-17T21:55:07+00:00
                        subject: CN=proxyhostname1.contoso.com
                        thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                      hostName: proxyhostname1.contoso.com
                      negotiateClientCertificate: false
                      type: Proxy
                    - certificate:
                        expiry: 2018-03-17T21:55:07+00:00
                        subject: CN=proxyhostname2.contoso.com
                        thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                      hostName: proxyhostname2.contoso.com
                      negotiateClientCertificate: true
                      type: Proxy
                    - certificate:
                        expiry: 2018-03-17T21:55:07+00:00
                        subject: CN=portalhostname1.contoso.com
                        thumbprint: 918D7785B926AC5AEE66322778A147BCE7237CF3
                      hostName: portalhostname1.contoso.com
                      negotiateClientCertificate: false
                      type: Portal
                  provisioningState: Created
                  publicIPAddresses: []
                  publisherEmail: admin@live.com
                  publisherName: contoso
                  targetProvisioningState: Activating
                  virtualNetworkConfiguration:
                    subnetResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/centralUsVirtualNetwork/subnets/apimSubnet
                  virtualNetworkType: External
                sku:
                  capacity: 1
                  name: Premium
                tags: {}
                type: Microsoft.ApiManagement/service
              headers:
                location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2019-01-01
            "202":
              headers:
                location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2019-01-01
        ApiManagementCreateService:
          parameters:
            api-version: 2019-01-01
            parameters:
              location: Central US
              properties:
                publisherEmail: apim@autorestsdk.com
                publisherName: autorestsdk
              sku:
                capacity: 1
                name: Developer
              tags:
                tag1: value1
                tag2: value2
                tag3: value3
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAFzSFg=
                id: /subscriptions/subid/resourceGroups/sdktestrg9348/providers/Microsoft.ApiManagement/service/apimService1
                location: Central US
                name: apimService1
                properties:
                  createdAtUtc: 2019-04-11T07:02:18.8577084Z
                  customProperties:
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11: "False"
                  gatewayRegionalUrl: https://apimService1-centralus-01.regional.azure-api.net
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations:
                    - defaultSslBinding: true
                      hostName: apimService1.azure-api.net
                      negotiateClientCertificate: false
                      type: Proxy
                  managementApiUrl: https://apimService1.management.azure-api.net
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  portalUrl: https://apimService1.portal.azure-api.net
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 13.89.236.232
                  publisherEmail: apim@autorestsdk.com
                  publisherName: autorestsdk
                  scmUrl: https://apimService1.scm.azure-api.net
                  targetProvisioningState: ""
                  virtualNetworkType: None
                sku:
                  capacity: 1
                  name: Developer
                tags:
                  tag1: value1
                  tag2: value2
                  tag3: value3
                type: Microsoft.ApiManagement/service
            "201":
              body:
                etag: AAAAAAFzRiw=
                id: /subscriptions/subid/resourceGroups/sdktestrg9348/providers/Microsoft.ApiManagement/service/apimService1
                location: Central US
                name: apimService1
                properties:
                  createdAtUtc: 2019-04-11T07:02:18.8577084Z
                  hostnameConfigurations:
                    - defaultSslBinding: true
                      hostName: apimService1.azure-api.net
                      negotiateClientCertificate: false
                      type: Proxy
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  provisioningState: Created
                  publisherEmail: apim@autorestsdk.com
                  publisherName: autorestsdk
                  targetProvisioningState: Activating
                  virtualNetworkType: None
                sku:
                  capacity: 1
                  name: Developer
                tags:
                  tag1: value1
                  tag2: value2
                  tag3: value3
                type: Microsoft.ApiManagement/service
              headers:
                location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2019-01-01
            "202":
              headers:
                location: https://management.azure.com/subscriptions/subid/resourceGroups/sdktestrg9348/providers/Microsoft.ApiManagement/service/apimService1/operationresults/c2RrdGVzdGFwaW0xNTkxX0FjdF9jZTkyMmNmOQ==?api-version=2019-01-01
        ApiManagementCreateServiceHavingMsi:
          parameters:
            api-version: 2019-01-01
            parameters:
              identity:
                type: SystemAssigned
              location: West US
              properties:
                publisherEmail: apim@autorestsdk.com
                publisherName: autorestsdk
              sku:
                name: Consumption
              tags:
                tag1: value1
                tag2: value2
                tag3: value3
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAAAWiU=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                identity:
                  principalId: dfb9a757-df69-4966-a8d0-711a9cd8ffb4
                  tenantId: XXXXXX-86f1-41af-91ab-2d7cd011db47
                  type: SystemAssigned
                location: West US
                name: apimService1
                properties:
                  createdAtUtc: 2019-04-11T16:29:29.9711098Z
                  enableClientCertificate: false
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations:
                    - defaultSslBinding: true
                      hostName: apimService1.azure-api.net
                      negotiateClientCertificate: false
                      type: Proxy
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  provisioningState: Succeeded
                  publisherEmail: apim@autorestsdk.com
                  publisherName: autorestsdk
                  targetProvisioningState: ""
                  virtualNetworkType: None
                sku:
                  capacity: 0
                  name: Consumption
                tags:
                  tag1: value1
                  tag2: value2
                  tag3: value3
                type: Microsoft.ApiManagement/service
            "201":
              body:
                etag: AAAAAAAAWiE=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                identity:
                  principalId: dfb9a757-df69-4966-a8d0-711a9cd8ffb4
                  tenantId: XXXXXX-86f1-41af-91ab-2d7cd011db47
                  type: SystemAssigned
                location: West US
                name: apimService1
                properties:
                  createdAtUtc: 2019-04-11T16:29:29.9711098Z
                  hostnameConfigurations:
                    - defaultSslBinding: true
                      hostName: apimService1.azure-api.net
                      negotiateClientCertificate: false
                      type: Proxy
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  provisioningState: Created
                  publisherEmail: apim@autorestsdk.com
                  publisherName: autorestsdk
                  targetProvisioningState: Activating
                  virtualNetworkType: None
                sku:
                  capacity: 0
                  name: Consumption
                tags:
                  tag1: value1
                  tag2: value2
                  tag3: value3
                type: Microsoft.ApiManagement/service
              headers:
                location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2019-01-01
            "202":
              headers:
                location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2019-01-01
        ApiManagementCreateServiceWithSystemCertificates:
          parameters:
            api-version: 2019-01-01
            parameters:
              location: Central US
              properties:
                certificates:
                  - certificatePassword: Password
                    encodedCertificate: "*******Base64 encoded Certificate******************"
                    storeName: CertificateAuthority
                publisherEmail: apim@autorestsdk.com
                publisherName: autorestsdk
              sku:
                capacity: 1
                name: Basic
              tags:
                tag1: value1
                tag2: value2
                tag3: value3
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAFzQXQ=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: Central US
                name: apimService1
                properties:
                  certificates:
                    - certificate:
                        expiry: 2035-12-31T23:00:00-08:00
                        subject: CN=*.msitesting.net
                        thumbprint: 8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2
                      storeName: CertificateAuthority
                  createdAtUtc: 2019-04-11T05:08:04.3228808Z
                  customProperties:
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10: "False"
                    Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11: "False"
                  gatewayRegionalUrl: https://apimService1-centralus-01.regional.azure-api.net
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations:
                    - defaultSslBinding: true
                      hostName: apimService1.azure-api.net
                      negotiateClientCertificate: false
                      type: Proxy
                  managementApiUrl: https://apimService1.management.azure-api.net
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  portalUrl: https://apimService1.portal.azure-api.net
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 40.113.228.6
                  publisherEmail: apim@autorestsdk.com
                  publisherName: autorestsdk
                  scmUrl: https://apimService1.scm.azure-api.net
                  targetProvisioningState: ""
                  virtualNetworkType: None
                sku:
                  capacity: 1
                  name: Basic
                tags:
                  tag1: value1
                  tag2: value2
                  tag3: value3
                type: Microsoft.ApiManagement/service
            "201":
              body:
                etag: AAAAAADauaY=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: Central US
                name: apimService1
                properties:
                  certificates:
                    - certificate:
                        expiry: 2035-12-31T23:00:00-08:00
                        subject: CN=*.msitesting.net
                        thumbprint: 8E989652XXXXXXXXXXXXXXXDB3A2
                      storeName: CertificateAuthority
                  createdAtUtc: 2018-02-19T16:42:47.362368Z
                  hostnameConfigurations: []
                  notificationSenderEmail: apimgmt-noreply@mail.windowsazure.com
                  provisioningState: Created
                  publisherEmail: apim@autorestsdk.com
                  publisherName: autorestsdk
                  targetProvisioningState: Activating
                  virtualNetworkType: None
                sku:
                  capacity: 1
                  name: Basic
                tags:
                  tag1: value1
                  tag2: value2
                  tag3: value3
                type: Microsoft.ApiManagement/service
              headers:
                location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2019-01-01
            "202":
              headers:
                location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2019-01-01
      x-ms-long-running-operation: true
  "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates":
    post:
      description: Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings.
      operationId: ApiManagementService_ApplyNetworkConfigurationUpdates
      parameters:
        - description: The name of the resource group.
          in: path
          name: resourceGroupName
          required: true
          type: string
          x-ms-parameter-location: method
        - description: The name of the API Management service.
          in: path
          maxLength: 50
          minLength: 1
          name: serviceName
          pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
          required: true
          type: string
          x-ms-parameter-location: method
        - description: Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region.
          in: body
          name: parameters
          required: false
          schema:
            $ref: "#/definitions/ApiManagementServiceApplyNetworkConfigurationParameters"
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: Network configuration updates were successfully applied on the Api Management service.
          schema:
            $ref: "#/definitions/ApiManagementServiceResource"
        "202":
          description: "Accepted: Location header contains the URL where the status of the long running operation can be checked."
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementApplyNetworkConfigurationUpdates:
          parameters:
            api-version: 2019-01-01
            parameters:
              location: west us
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAAXX6Y=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: East Asia
                name: apimService1
                properties:
                  createdAtUtc: 2015-09-22T01:50:34.7921566Z
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations: []
                  managementApiUrl: https://apimService1.management.azure-api.net
                  portalUrl: https://apimService1.portal.azure-api.net
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 207.46.155.24
                  publisherEmail: admin@live.com
                  publisherName: Contoso
                  scmUrl: https://apimService1.scm.azure-api.net
                  targetProvisioningState: ""
                  virtualNetworkConfiguration:
                    subnetResourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet
                  virtualNetworkType: External
                sku:
                  capacity: 1
                  name: Premium
                tags:
                  UID: 52ed5986-717b-45b4-b17c-3df8db372cff
                type: Microsoft.ApiManagement/service
            "202":
              headers:
                location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2019-01-01
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
  "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup":
    post:
      description: Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
      operationId: ApiManagementService_Backup
      parameters:
        - description: The name of the resource group.
          in: path
          name: resourceGroupName
          required: true
          type: string
          x-ms-parameter-location: method
        - description: The name of the API Management service.
          in: path
          maxLength: 50
          minLength: 1
          name: serviceName
          pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
          required: true
          type: string
          x-ms-parameter-location: method
        - description: Parameters supplied to the ApiManagementService_Backup operation.
          in: body
          name: parameters
          required: true
          schema:
            $ref: "#/definitions/ApiManagementServiceBackupRestoreParameters"
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: Successfully backed up the API Management service to the storage account.
          schema:
            $ref: "#/definitions/ApiManagementServiceResource"
        "202":
          description: "Accepted: Location header contains the URL where the status of the long running operation can be checked."
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementCreateBackup:
          parameters:
            api-version: 2019-01-01
            parameters:
              accessKey: "**************************************************"
              backupName: apimService1backup_2017_03_19
              containerName: backupContainer
              storageAccount: teststorageaccount
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAAXX6Y=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: East Asia
                name: apimService1
                properties:
                  createdAtUtc: 2015-09-22T01:50:34.7921566Z
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations: []
                  managementApiUrl: https://apimService1.management.azure-api.net
                  portalUrl: https://apimService1.portal.azure-api.net
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 207.46.155.24
                  publisherEmail: admin@live.com
                  publisherName: Contoso
                  scmUrl: https://apimService1.scm.azure-api.net
                  targetProvisioningState: ""
                  virtualNetworkType: None
                sku:
                  capacity: 1
                  name: Premium
                tags:
                  UID: 52ed5986-717b-45b4-b17c-3df8db372cff
                type: Microsoft.ApiManagement/service
            "202":
              headers:
                location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2019-01-01
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
  "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken":
    post:
      description: Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
      operationId: ApiManagementService_GetSsoToken
      parameters:
        - description: The name of the resource group.
          in: path
          name: resourceGroupName
          required: true
          type: string
          x-ms-parameter-location: method
        - description: The name of the API Management service.
          in: path
          maxLength: 50
          minLength: 1
          name: serviceName
          pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
          required: true
          type: string
          x-ms-parameter-location: method
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: OK if successful with the SSO Redirect URI.
          schema:
            $ref: "#/definitions/ApiManagementServiceGetSsoTokenResult"
            x-ms-client-flatten: true
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementServiceGetSsoToken:
          parameters:
            api-version: 2019-01-01
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                redirectUri: https://apimService1.portal.azure-api.net:443/signin-sso?token=1%26201705301929%26eIkr3%2fnfaLs1GVJ0OVbzkJjAcwPFkEZAPM8VUXvXPf7cJ6lWsB9oUwsk2zln9x0KLkn21txCPJWWheSPq7SNeA%3d%3d
  "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore":
    post:
      description: Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.
      operationId: ApiManagementService_Restore
      parameters:
        - description: The name of the resource group.
          in: path
          name: resourceGroupName
          required: true
          type: string
          x-ms-parameter-location: method
        - description: The name of the API Management service.
          in: path
          maxLength: 50
          minLength: 1
          name: serviceName
          pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
          required: true
          type: string
          x-ms-parameter-location: method
        - description: Parameters supplied to the Restore API Management service from backup operation.
          in: body
          name: parameters
          required: true
          schema:
            $ref: "#/definitions/ApiManagementServiceBackupRestoreParameters"
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: Successfully restored the backup onto the API Management service.
          schema:
            $ref: "#/definitions/ApiManagementServiceResource"
        "202":
          description: "Accepted: Location header contains the URL where the status of the long running operation can be checked."
      tags:
        - ApiManagementService
      x-ms-examples:
        ApiManagementRestoreService:
          parameters:
            api-version: 2019-01-01
            parameters:
              accessKey: "**************************************************"
              backupName: apimService1backup_2017_03_19
              containerName: backupContainer
              storageAccount: teststorageaccount
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                etag: AAAAAAAXX6Y=
                id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1
                location: East Asia
                name: apimService1
                properties:
                  createdAtUtc: 2015-09-22T01:50:34.7921566Z
                  gatewayUrl: https://apimService1.azure-api.net
                  hostnameConfigurations: []
                  managementApiUrl: https://apimService1.management.azure-api.net
                  portalUrl: https://apimService1.portal.azure-api.net
                  provisioningState: Succeeded
                  publicIPAddresses:
                    - 207.46.155.24
                  publisherEmail: admin@live.com
                  publisherName: Contoso
                  scmUrl: https://apimService1.scm.azure-api.net
                  targetProvisioningState: ""
                  virtualNetworkType: None
                sku:
                  capacity: 1
                  name: Premium
                tags:
                  UID: 52ed5986-717b-45b4-b17c-3df8db372cff
                type: Microsoft.ApiManagement/service
            "202":
              headers:
                location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2019-01-01
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
  "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus":
    get:
      description: Gets all available SKU for a given API Management service
      operationId: ApiManagementServiceSkus_ListAvailableServiceSkus
      parameters:
        - description: The name of the resource group.
          in: path
          name: resourceGroupName
          required: true
          type: string
          x-ms-parameter-location: method
        - description: The name of the API Management service.
          in: path
          maxLength: 50
          minLength: 1
          name: serviceName
          pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
          required: true
          type: string
          x-ms-parameter-location: method
        - description: Version of the API to be used with the client request.
          in: query
          name: api-version
          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.
          in: path
          name: subscriptionId
          required: true
          type: string
      responses:
        "200":
          description: Success. The response describes the list of SKUs.
          schema:
            $ref: "#/definitions/ResourceSkuResults"
      summary: Gets available SKUs for API Management service
      tags:
        - ApiManagementServiceSkus
      x-ms-examples:
        ApiManagementListSKUs-Consumption:
          parameters:
            api-version: 2019-01-01
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                nextLink: null
                value:
                  - capacity: null
                    resourceType: Microsoft.ApiManagement/service
                    sku:
                      name: Consumption
        ApiManagementListSKUs-Dedicated:
          parameters:
            api-version: 2019-01-01
            resourceGroupName: rg1
            serviceName: apimService1
            subscriptionId: subid
          responses:
            "200":
              body:
                nextLink: null
                value:
                  - capacity:
                      default: 1
                      maximum: 1
                      minimum: 1
                      scaleType: none
                    resourceType: Microsoft.ApiManagement/service
                    sku:
                      name: Developer
                  - capacity:
                      default: 1
                      maximum: 2
                      minimum: 1
                      scaleType: manual
                    resourceType: Microsoft.ApiManagement/service
                    sku:
                      name: Basic
                  - capacity:
                      default: 1
                      maximum: 4
                      minimum: 1
                      scaleType: automatic
                    resourceType: Microsoft.ApiManagement/service
                    sku:
                      name: Standard
                  - capacity:
                      default: 1
                      maximum: 10
                      minimum: 1
                      scaleType: automatic
                    resourceType: Microsoft.ApiManagement/service
                    sku:
                      name: Premium
      x-ms-pageable:
        nextLinkName: nextLink
definitions:
  AdditionalLocation:
    description: Description of an additional API Management resource location.
    properties:
      gatewayRegionalUrl:
        description: Gateway URL of the API Management service in the Region.
        readOnly: true
        type: string
      location:
        description: The location name of the additional region among Azure Data center regions.
        type: string
      privateIPAddresses:
        description: Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard and Premium SKU.
        items:
          type: string
        readOnly: true
        type: array
      publicIPAddresses:
        description: Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.
        items:
          type: string
        readOnly: true
        type: array
      sku:
        $ref: "#/definitions/ApiManagementServiceSkuProperties"
        description: SKU properties of the API Management service.
      virtualNetworkConfiguration:
        $ref: "#/definitions/VirtualNetworkConfiguration"
        description: Virtual network configuration for the location.
    required:
      - location
      - sku
  ApiManagementServiceApplyNetworkConfigurationParameters:
    description: Parameter supplied to the Apply Network configuration operation.
    properties:
      location:
        description: Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required.
        type: string
  ApiManagementServiceBackupRestoreParameters:
    description: Parameters supplied to the Backup/Restore of an API Management service operation.
    properties:
      accessKey:
        description: Azure Cloud Storage account (used to place/retrieve the backup) access key.
        type: string
      backupName:
        description: The name of the backup file to create.
        type: string
      containerName:
        description: Azure Cloud Storage blob container name used to place/retrieve the backup.
        type: string
      storageAccount:
        description: Azure Cloud Storage account (used to place/retrieve the backup) name.
        type: string
    required:
      - storageAccount
      - accessKey
      - containerName
      - backupName
  ApiManagementServiceBaseProperties:
    description: Base Properties of an API Management service resource description.
    properties:
      additionalLocations:
        description: Additional datacenter locations of the API Management service.
        items:
          $ref: "#/definitions/AdditionalLocation"
        type: array
      certificates:
        description: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
        items:
          $ref: "#/definitions/CertificateConfiguration"
        type: array
      createdAtUtc:
        description: "Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard."
        format: date-time
        readOnly: true
        type: string
      customProperties:
        additionalProperties:
          type: string
        description: "Custom properties of the API Management service.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.</br>Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is `True` if the service was created on or before April 1st 2018 and `False` otherwise. Http2 setting's default value is `False`.</br></br>You can disable any of next ciphers by using settings `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. The default value is `true` for them."
        type: object
      enableClientCertificate:
        default: false
        description: Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.
        type: boolean
      gatewayRegionalUrl:
        description: Gateway URL of the API Management service in the Default Region.
        readOnly: true
        type: string
      gatewayUrl:
        description: Gateway URL of the API Management service.
        readOnly: true
        type: string
      hostnameConfigurations:
        description: Custom hostname configuration of the API Management service.
        items:
          $ref: "#/definitions/HostnameConfiguration"
        type: array
      managementApiUrl:
        description: Management API endpoint URL of the API Management service.
        readOnly: true
        type: string
      notificationSenderEmail:
        description: Email address from which the notification will be sent.
        maxLength: 100
        type: string
      portalUrl:
        description: Publisher portal endpoint Url of the API Management service.
        readOnly: true
        type: string
      privateIPAddresses:
        description: Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU.
        items:
          type: string
        readOnly: true
        type: array
      provisioningState:
        description: "The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted."
        readOnly: true
        type: string
      publicIPAddresses:
        description: Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
        items:
          type: string
        readOnly: true
        type: array
      scmUrl:
        description: SCM endpoint URL of the API Management service.
        readOnly: true
        type: string
      targetProvisioningState:
        description: The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
        readOnly: true
        type: string
      virtualNetworkConfiguration:
        $ref: "#/definitions/VirtualNetworkConfiguration"
        description: Virtual network configuration of the API Management service.
      virtualNetworkType:
        default: None
        description: The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.
        enum:
          - None
          - External
          - Internal
        type: string
        x-ms-enum:
          modelAsString: true
          name: VirtualNetworkType
          values:
            - description: The service is not part of any Virtual Network.
              value: None
            - description: The service is part of Virtual Network and it is accessible from Internet.
              value: External
            - description: The service is part of Virtual Network and it is only accessible from within the virtual network.
              value: Internal
  ApiManagementServiceCheckNameAvailabilityParameters:
    description: Parameters supplied to the CheckNameAvailability operation.
    properties:
      name:
        description: The name to check for availability.
        type: string
    required:
      - name
  ApiManagementServiceGetSsoTokenResult:
    description: The response of the GetSsoToken operation.
    properties:
      redirectUri:
        description: Redirect URL to the Publisher Portal containing the SSO token.
        type: string
  ApiManagementServiceIdentity:
    description: Identity properties of the Api Management service resource.
    properties:
      principalId:
        description: The principal id of the identity.
        format: uuid
        readOnly: true
        type: string
      tenantId:
        description: The client tenant id of the identity.
        format: uuid
        readOnly: true
        type: string
      type:
        description: The identity type. Currently the only supported type is 'SystemAssigned'.
        enum:
          - SystemAssigned
        type: string
        x-ms-enum:
          modelAsString: true
          name: ApimIdentityType
    required:
      - type
  ApiManagementServiceListResult:
    description: The response of the List API Management services operation.
    properties:
      nextLink:
        description: Link to the next set of results. Not empty if Value contains incomplete list of API Management services.
        type: string
      value:
        description: Result of the List API Management services operation.
        items:
          $ref: "#/definitions/ApiManagementServiceResource"
        type: array
    required:
      - value
  ApiManagementServiceNameAvailabilityResult:
    description: Response of the CheckNameAvailability operation.
    properties:
      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 <resourceName> is already in use, and direct them to select a different name.
        readOnly: true
        type: string
      nameAvailable:
        description: True if the name is available and can be used to create a new API Management service; otherwise false.
        readOnly: true
        type: boolean
      reason:
        description: Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.)  AlreadyExists indicates that the name is already in use and is therefore unavailable.
        enum:
          - Valid
          - Invalid
          - AlreadyExists
        type: string
        x-ms-enum:
          modelAsString: false
          name: NameAvailabilityReason
  ApiManagementServiceProperties:
    allOf:
      - $ref: "#/definitions/ApiManagementServiceBaseProperties"
    description: Properties of an API Management service resource description.
    properties:
      publisherEmail:
        description: Publisher email.
        maxLength: 100
        type: string
      publisherName:
        description: Publisher name.
        maxLength: 100
        type: string
    required:
      - publisherEmail
      - publisherName
  ApiManagementServiceResource:
    allOf:
      - $ref: "#/definitions/ApimResource"
    description: A single API Management service resource in List or Get response.
    properties:
      etag:
        description: ETag of the resource.
        readOnly: true
        type: string
      identity:
        $ref: "#/definitions/ApiManagementServiceIdentity"
        description: Managed service identity of the Api Management service.
      location:
        description: Resource location.
        type: string
        x-ms-mutability:
          - read
          - create
      properties:
        $ref: "#/definitions/ApiManagementServiceProperties"
        description: Properties of the API Management service.
        x-ms-client-flatten: true
      sku:
        $ref: "#/definitions/ApiManagementServiceSkuProperties"
        description: SKU properties of the API Management service.
    required:
      - location
      - sku
      - properties
  ApiManagementServiceSkuProperties:
    description: API Management service resource SKU properties.
    properties:
      capacity:
        description: Capacity of the SKU (number of deployed units of the SKU).
        format: int32
        type: integer
      name:
        description: Name of the Sku.
        enum:
          - Developer
          - Standard
          - Premium
          - Basic
          - Consumption
        externalDocs:
          url: https://azure.microsoft.com/en-us/pricing/details/api-management/
        type: string
        x-ms-enum:
          modelAsString: true
          name: SkuType
          values:
            - description: Developer SKU of Api Management.
              value: Developer
            - description: Standard SKU of Api Management.
              value: Standard
            - description: Premium SKU of Api Management.
              value: Premium
            - description: Basic SKU of Api Management.
              value: Basic
            - description: Consumption SKU of Api Management.
              value: Consumption
    required:
      - name
  ApiManagementServiceUpdateParameters:
    allOf:
      - $ref: "#/definitions/ApimResource"
    description: Parameter supplied to Update Api Management Service.
    properties:
      etag:
        description: ETag of the resource.
        readOnly: true
        type: string
      identity:
        $ref: "#/definitions/ApiManagementServiceIdentity"
        description: Managed service identity of the Api Management service.
      properties:
        $ref: "#/definitions/ApiManagementServiceUpdateProperties"
        description: Properties of the API Management service.
        x-ms-client-flatten: true
      sku:
        $ref: "#/definitions/ApiManagementServiceSkuProperties"
        description: SKU properties of the API Management service.
  ApiManagementServiceUpdateProperties:
    allOf:
      - $ref: "#/definitions/ApiManagementServiceBaseProperties"
    description: Properties of an API Management service resource description.
    properties:
      publisherEmail:
        description: Publisher email.
        maxLength: 100
        type: string
      publisherName:
        description: Publisher name.
        maxLength: 100
        type: string
  ApimResource:
    description: The Resource definition.
    properties:
      id:
        description: Resource ID.
        readOnly: true
        type: string
      name:
        description: Resource name.
        readOnly: true
        type: string
      tags:
        additionalProperties:
          type: string
        description: Resource tags.
        type: object
      type:
        description: Resource type for API Management resource is set to Microsoft.ApiManagement.
        readOnly: true
        type: string
    x-ms-azure-resource: true
  CertificateConfiguration:
    description: Certificate configuration which consist of non-trusted intermediates and root certificates.
    properties:
      certificate:
        $ref: "#/definitions/CertificateInformation"
        description: Certificate information.
      certificatePassword:
        description: Certificate Password.
        type: string
      encodedCertificate:
        description: Base64 Encoded certificate.
        type: string
      storeName:
        description: The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
        enum:
          - CertificateAuthority
          - Root
        type: string
    required:
      - storeName
  CertificateInformation:
    description: SSL certificate information.
    properties:
      expiry:
        description: "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard."
        format: date-time
        type: string
      subject:
        description: Subject of the certificate.
        type: string
      thumbprint:
        description: Thumbprint of the certificate.
        type: string
    required:
      - expiry
      - thumbprint
      - subject
  HostnameConfiguration:
    description: Custom hostname configuration.
    properties:
      certificate:
        $ref: "#/definitions/CertificateInformation"
        description: Certificate information.
      certificatePassword:
        description: Certificate Password.
        type: string
      defaultSslBinding:
        default: false
        description: Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.
        type: boolean
      encodedCertificate:
        description: Base64 Encoded certificate.
        type: string
      hostName:
        description: Hostname to configure on the Api Management service.
        type: string
      keyVaultId:
        description: Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type *application/x-pkcs12*
        type: string
      negotiateClientCertificate:
        default: false
        description: Specify true to always negotiate client certificate on the hostname. Default Value is false.
        type: boolean
      type:
        description: Hostname type.
        enum:
          - Proxy
          - Portal
          - Management
          - Scm
          - DeveloperPortal
        type: string
        x-ms-enum:
          modelAsString: true
          name: HostnameType
    required:
      - type
      - hostName
  Operation:
    description: REST API operation
    properties:
      display:
        description: The object that describes the operation.
        properties:
          description:
            description: Friendly name of the operation
            type: string
          operation:
            description: "Operation type: read, write, delete, listKeys/action, etc."
            type: string
          provider:
            description: Friendly name of the resource provider
            type: string
          resource:
            description: Resource type on which the operation is performed.
            type: string
      name:
        description: "Operation name: {provider}/{resource}/{operation}"
        type: string
      origin:
        description: The operation origin.
        type: string
      properties:
        description: The operation properties.
        type: object
        x-ms-client-flatten: true
    type: object
  OperationListResult:
    description: Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.
    properties:
      nextLink:
        description: URL to get the next set of operation list results if there are any.
        type: string
      value:
        description: List of operations supported by the resource provider.
        items:
          $ref: "#/definitions/Operation"
        type: array
  ResourceSku:
    description: Describes an available API Management SKU.
    properties:
      name:
        description: Name of the Sku.
        enum:
          - Developer
          - Standard
          - Premium
          - Basic
          - Consumption
        externalDocs:
          url: https://azure.microsoft.com/en-us/pricing/details/api-management/
        type: string
        x-ms-enum:
          modelAsString: true
          name: SkuType
          values:
            - description: Developer SKU of Api Management.
              value: Developer
            - description: Standard SKU of Api Management.
              value: Standard
            - description: Premium SKU of Api Management.
              value: Premium
            - description: Basic SKU of Api Management.
              value: Basic
            - description: Consumption SKU of Api Management.
              value: Consumption
  ResourceSkuCapacity:
    description: Describes scaling information of a SKU.
    properties:
      default:
        description: The default capacity.
        format: int32
        readOnly: true
        type: integer
      maximum:
        description: The maximum capacity that can be set.
        format: int32
        readOnly: true
        type: integer
      minimum:
        description: The minimum capacity.
        format: int32
        readOnly: true
        type: integer
      scaleType:
        description: The scale type applicable to the sku.
        enum:
          - automatic
          - manual
          - none
        readOnly: true
        type: string
        x-ms-enum:
          modelAsString: true
          name: ResourceSkuCapacityScaleType
          values:
            - description: Supported scale type automatic.
              value: automatic
            - description: Supported scale type manual.
              value: manual
            - description: Scaling not supported.
              value: none
  ResourceSkuResult:
    description: Describes an available API Management service SKU.
    properties:
      capacity:
        $ref: "#/definitions/ResourceSkuCapacity"
        description: Specifies the number of API Management units.
        readOnly: true
      resourceType:
        description: The type of resource the SKU applies to.
        readOnly: true
        type: string
      sku:
        $ref: "#/definitions/ResourceSku"
        description: Specifies API Management SKU.
        readOnly: true
  ResourceSkuResults:
    description: The API Management service SKUs operation response.
    properties:
      nextLink:
        description: The uri to fetch the next page of API Management service Skus.
        type: string
      value:
        description: The list of skus available for the service.
        items:
          $ref: "#/definitions/ResourceSkuResult"
        type: array
    required:
      - value
  VirtualNetworkConfiguration:
    description: Configuration of a virtual network to which API Management service is deployed.
    properties:
      subnetResourceId:
        description: The full resource ID of a subnet in a virtual network to deploy the API Management service in.
        pattern: ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$
        type: string
      subnetname:
        description: The name of the subnet.
        readOnly: true
        type: string
      vnetid:
        description: The virtual network ID. This is typically a GUID. Expect a null GUID by default.
        readOnly: true
        type: string
