swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector CustomRollouts API
schemes:
- https
tags:
- name: CustomRollouts
paths:
  ? /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/customRollouts/{rolloutName}
  : get:
      tags:
      - CustomRollouts
      description: Gets the custom rollout details.
      operationId: microsoftAzureCustomrolloutsGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - $ref: '#/parameters/GetRolloutNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Successfully retrieved the rollout details.
          schema:
            $ref: '#/definitions/CustomRollout'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        CustomRollouts_Get:
          $ref: ./examples/CustomRollouts_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace Customrollouts Rolloutname
    put:
      tags:
      - CustomRollouts
      description: Creates or updates the rollout details.
      operationId: microsoftAzureCustomrolloutsCreateorupdate
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - $ref: '#/parameters/GetRolloutNameParameter'
      - name: properties
        in: body
        required: true
        schema:
          $ref: '#/definitions/CustomRollout'
        description: The custom rollout properties supplied to the CreateOrUpdate operation.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Rollout completed successfully.
          schema:
            $ref: '#/definitions/CustomRollout'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        CustomRollouts_CreateOrUpdate:
          $ref: ./examples/CustomRollouts_CreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace Customrollouts Rolloutname
  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/customRollouts:
    get:
      tags:
      - CustomRollouts
      description: Gets the list of the custom rollouts for the given provider.
      operationId: microsoftAzureCustomrolloutsListbyproviderregistration
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Successfully retrieved the list of custom rollouts for given provider.
          schema:
            $ref: '#/definitions/CustomRolloutArrayResponseWithContinuation'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        CustomRollouts_ListByProviderRegistration:
          $ref: ./examples/CustomRollouts_ListByProviderRegistration.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace Customrollouts
definitions:
  SubscriptionStateOverrideAction:
    required:
    - action
    - state
    type: object
    properties:
      state:
        enum:
        - Registered
        - Unregistered
        - Warned
        - Suspended
        - Deleted
        - WarnedToRegistered
        - WarnedToSuspended
        - WarnedToDeleted
        - WarnedToUnregistered
        - SuspendedToRegistered
        - SuspendedToWarned
        - SuspendedToDeleted
        - SuspendedToUnregistered
        type: string
        x-ms-enum:
          name: SubscriptionTransitioningState
          modelAsString: true
      action:
        enum:
        - NotDefined
        - DeleteAllResources
        - SoftDeleteAllResources
        - NoOp
        - BillingCancellation
        - UndoSoftDelete
        type: string
        x-ms-enum:
          name: SubscriptionNotificationOperation
          modelAsString: true
  ProviderRegistration:
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
    properties:
      properties:
        allOf:
        - $ref: '#/definitions/ProviderRegistrationProperties'
      systemData:
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData
        readOnly: true
    x-ms-azure-resource: true
  ResourceConcurrencyControlOption:
    type: object
    properties:
      policy:
        enum:
        - NotSpecified
        - SynchronizeBeginExtension
        type: string
        x-ms-enum:
          name: Policy
          modelAsString: true
  ExtendedLocationOptions:
    type: object
    properties:
      type:
        type: string
      supportedPolicy:
        type: string
  ResourceTypeRegistration:
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
    properties:
      properties:
        allOf:
        - $ref: '#/definitions/ResourceTypeRegistrationProperties'
      systemData:
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData
        readOnly: true
    x-ms-azure-resource: true
  ResourceTypeEndpoint:
    type: object
    properties:
      enabled:
        type: boolean
      apiVersions:
        type: array
        items:
          type: string
      locations:
        type: array
        items:
          type: string
      requiredFeatures:
        type: array
        items:
          type: string
      featuresRule:
        allOf:
        - $ref: '#/definitions/FeaturesRule'
      extensions:
        type: array
        items:
          $ref: '#/definitions/ResourceTypeExtension'
      timeout:
        format: duration
        type: string
      endpointType:
        enum:
        - NotSpecified
        - Canary
        - Production
        - TestInProduction
        type: string
        x-ms-enum:
          name: EndpointType
          modelAsString: true
  ResourceProviderCapabilities:
    required:
    - effect
    - quotaId
    type: object
    properties:
      quotaId:
        type: string
      effect:
        enum:
        - NotSpecified
        - Allow
        - Disallow
        type: string
        x-ms-enum:
          name: ResourceProviderCapabilitiesEffect
          modelAsString: true
      requiredFeatures:
        type: array
        items:
          type: string
  ThrottlingMetric:
    required:
    - limit
    - type
    type: object
    properties:
      type:
        enum:
        - NotSpecified
        - NumberOfRequests
        - NumberOfResources
        type: string
        x-ms-enum:
          name: ThrottlingMetricType
          modelAsString: true
      limit:
        format: int64
        type: integer
      interval:
        format: duration
        type: string
  TrafficRegions:
    type: object
    properties:
      regions:
        type: array
        items:
          type: string
  ResourceProviderManifestProperties:
    type: object
    properties:
      providerAuthentication:
        allOf:
        - $ref: '#/definitions/ResourceProviderAuthentication'
      providerAuthorizations:
        type: array
        items:
          $ref: '#/definitions/ResourceProviderAuthorization'
      namespace:
        type: string
      providerVersion:
        type: string
      providerType:
        enum:
        - NotSpecified
        - Internal
        - External
        - Hidden
        - RegistrationFree
        - LegacyRegistrationRequired
        - TenantOnly
        - AuthorizationFree
        type: string
        x-ms-enum:
          name: ResourceProviderType
          modelAsString: true
      requiredFeatures:
        type: array
        items:
          type: string
      featuresRule:
        allOf:
        - $ref: '#/definitions/FeaturesRule'
      requestHeaderOptions:
        allOf:
        - $ref: '#/definitions/RequestHeaderOptions'
      management:
        allOf:
        - $ref: '#/definitions/ResourceProviderManagement'
      capabilities:
        type: array
        items:
          $ref: '#/definitions/ResourceProviderCapabilities'
      metadata: {}
      templateDeploymentOptions:
        allOf:
        - $ref: '#/definitions/TemplateDeploymentOptions'
  ResourceTypeExtension:
    type: object
    properties:
      endpointUri:
        type: string
      extensionCategories:
        type: array
        items:
          enum:
          - NotSpecified
          - ResourceCreationValidate
          - ResourceCreationBegin
          - ResourceCreationCompleted
          - ResourceReadValidate
          - ResourceReadBegin
          - ResourcePatchValidate
          - ResourcePatchCompleted
          - ResourceDeletionValidate
          - ResourceDeletionBegin
          - ResourceDeletionCompleted
          - ResourcePostAction
          - SubscriptionLifecycleNotification
          - ResourcePatchBegin
          - ResourceMoveBegin
          - ResourceMoveCompleted
          type: string
          x-ms-enum:
            name: ExtensionCategory
            modelAsString: true
      timeout:
        format: duration
        type: string
  IdentityManagementProperties:
    type: object
    properties:
      type:
        enum:
        - NotSpecified
        - SystemAssigned
        - UserAssigned
        - Actor
        - DelegatedResourceIdentity
        type: string
        x-ms-enum:
          name: IdentityManagementTypes
          modelAsString: true
      applicationId:
        type: string
  LightHouseAuthorization:
    required:
    - principalId
    - roleDefinitionId
    type: object
    properties:
      principalId:
        type: string
      roleDefinitionId:
        type: string
  ProviderHubMetadata:
    type: object
    properties:
      providerAuthorizations:
        type: array
        items:
          $ref: '#/definitions/ResourceProviderAuthorization'
      providerAuthentication:
        allOf:
        - $ref: '#/definitions/ResourceProviderAuthentication'
      thirdPartyProviderAuthorization:
        allOf:
        - $ref: '#/definitions/ThirdPartyProviderAuthorization'
  CheckNameAvailabilitySpecifications:
    type: object
    properties:
      enableDefaultValidation:
        type: boolean
      resourceTypesWithCustomValidation:
        type: array
        items:
          type: string
  CustomRollout:
    description: Rollout details.
    type: object
    required:
    - properties
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
    properties:
      properties:
        allOf:
        - $ref: '#/definitions/CustomRolloutProperties'
        description: Properties of the rollout.
      systemData:
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData
        readOnly: true
    x-ms-azure-resource: true
  ExtensionOptions:
    type: object
    properties:
      request:
        type: array
        items:
          enum:
          - NotSpecified
          - DoNotMergeExistingReadOnlyAndSecretProperties
          - IncludeInternalMetadata
          type: string
          x-ms-enum:
            name: ExtensionOptionType
            modelAsString: true
      response:
        type: array
        items:
          enum:
          - NotSpecified
          - DoNotMergeExistingReadOnlyAndSecretProperties
          - IncludeInternalMetadata
          type: string
          x-ms-enum:
            name: ExtensionOptionType
            modelAsString: true
  ThrottlingRule:
    required:
    - action
    - metrics
    type: object
    properties:
      action:
        type: string
      metrics:
        type: array
        items:
          $ref: '#/definitions/ThrottlingMetric'
      requiredFeatures:
        type: array
        items:
          type: string
  RequestHeaderOptions:
    type: object
    properties:
      optInHeaders:
        enum:
        - NotSpecified
        - SignedUserToken
        - ClientGroupMembership
        - SignedAuxiliaryTokens
        - UnboundedClientGroupMembership
        type: string
        x-ms-enum:
          name: OptInHeaderType
          modelAsString: true
  ResourceTypeExtensionOptions:
    type: object
    properties:
      resourceCreationBegin:
        allOf:
        - $ref: '#/definitions/ExtensionOptions'
  ResourceProviderAuthentication:
    required:
    - allowedAudiences
    type: object
    properties:
      allowedAudiences:
        type: array
        items:
          type: string
  OpenApiConfiguration:
    type: object
    properties:
      validation:
        $ref: '#/definitions/OpenApiValidation'
  ResourceGraphConfiguration:
    type: object
    properties:
      enabled:
        type: boolean
      apiVersion:
        type: string
  FeaturesRule:
    required:
    - requiredFeaturesPolicy
    type: object
    properties:
      requiredFeaturesPolicy:
        enum:
        - Any
        - All
        type: string
        x-ms-enum:
          name: FeaturesPolicy
          modelAsString: true
  ResourceTypeRegistrationProperties:
    type: object
    properties:
      routingType:
        enum:
        - Default
        - ProxyOnly
        - HostBased
        - Extension
        - Tenant
        - Fanout
        - LocationBased
        - Failover
        - CascadeExtension
        type: string
        x-ms-enum:
          name: RoutingType
          modelAsString: true
      regionality:
        enum:
        - NotSpecified
        - Global
        - Regional
        type: string
        x-ms-enum:
          name: Regionality
          modelAsString: true
      endpoints:
        type: array
        items:
          $ref: '#/definitions/ResourceTypeEndpoint'
      extensionOptions:
        allOf:
        - $ref: '#/definitions/ResourceTypeExtensionOptions'
      marketplaceType:
        enum:
        - NotSpecified
        - AddOn
        - Bypass
        - Store
        type: string
      swaggerSpecifications:
        type: array
        items:
          $ref: '#/definitions/SwaggerSpecification'
      allowedUnauthorizedActions:
        type: array
        items:
          type: string
      authorizationActionMappings:
        type: array
        items:
          $ref: '#/definitions/AuthorizationActionMapping'
      linkedAccessChecks:
        type: array
        items:
          $ref: '#/definitions/LinkedAccessCheck'
      defaultApiVersion:
        type: string
      loggingRules:
        type: array
        items:
          $ref: '#/definitions/LoggingRule'
      throttlingRules:
        type: array
        items:
          $ref: '#/definitions/ThrottlingRule'
      requiredFeatures:
        type: array
        items:
          type: string
      featuresRule:
        allOf:
        - $ref: '#/definitions/FeaturesRule'
      enableAsyncOperation:
        type: boolean
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The provisioned state of the resource.
      enableThirdPartyS2S:
        type: boolean
      subscriptionLifecycleNotificationSpecifications:
        allOf:
        - $ref: '#/definitions/SubscriptionLifecycleNotificationSpecifications'
      isPureProxy:
        type: boolean
      identityManagement:
        allOf:
        - $ref: '#/definitions/IdentityManagementProperties'
      checkNameAvailabilitySpecifications:
        allOf:
        - $ref: '#/definitions/CheckNameAvailabilitySpecifications'
      disallowedActionVerbs:
        type: array
        items:
          type: string
      serviceTreeInfos:
        type: array
        items:
          $ref: '#/definitions/ServiceTreeInfo'
      requestHeaderOptions:
        allOf:
        - $ref: '#/definitions/RequestHeaderOptions'
      subscriptionStateRules:
        type: array
        items:
          $ref: '#/definitions/SubscriptionStateRule'
      templateDeploymentOptions:
        allOf:
        - $ref: '#/definitions/TemplateDeploymentOptions'
      extendedLocations:
        type: array
        items:
          $ref: '#/definitions/ExtendedLocationOptions'
      resourceMovePolicy:
        allOf:
        - $ref: '#/definitions/ResourceMovePolicy'
      resourceDeletionPolicy:
        enum:
        - NotSpecified
        - CascadeDeleteAll
        - CascadeDeleteProxyOnlyChildren
        type: string
        x-ms-enum:
          name: ResourceDeletionPolicy
          modelAsString: true
      resourceConcurrencyControlOptions:
        type: object
        additionalProperties:
          $ref: '#/definitions/ResourceConcurrencyControlOption'
      resourceGraphConfiguration:
        allOf:
        - $ref: '#/definitions/ResourceGraphConfiguration'
      management:
        allOf:
        - $ref: '#/definitions/ResourceProviderManagement'
      openApiConfiguration:
        $ref: '#/definitions/OpenApiConfiguration'
  ProviderRegistrationProperties:
    type: object
    allOf:
    - $ref: '#/definitions/ResourceProviderManifestProperties'
    properties:
      providerHubMetadata:
        allOf:
        - $ref: '#/definitions/ProviderHubMetadata'
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The provisioned state of the resource.
      subscriptionLifecycleNotificationSpecifications:
        allOf:
        - $ref: '#/definitions/SubscriptionLifecycleNotificationSpecifications'
  CustomRolloutArrayResponseWithContinuation:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/CustomRollout'
      nextLink:
        description: The URL to get to the next set of results, if there are any.
        type: string
  ExtendedErrorInfo:
    type: object
    properties:
      code:
        type: string
      target:
        type: string
      message:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/ExtendedErrorInfo'
      additionalInfo:
        type: array
        items:
          $ref: '#/definitions/TypedErrorInfo'
  ServiceTreeInfo:
    type: object
    properties:
      serviceId:
        type: string
      componentId:
        type: string
      readiness:
        enum:
        - ClosingDown
        - Deprecated
        - GA
        - InDevelopment
        - InternalOnly
        - PrivatePreview
        - PublicPreview
        - RemovedFromARM
        - Retired
        type: string
        x-ms-enum:
          name: Readiness
          modelAsString: true
  LoggingRule:
    required:
    - action
    - detailLevel
    - direction
    type: object
    properties:
      action:
        type: string
      direction:
        enum:
        - None
        - Request
        - Response
        type: string
        x-ms-enum:
          name: LoggingDirections
          modelAsString: true
      detailLevel:
        enum:
        - None
        - Body
        type: string
        x-ms-enum:
          name: LoggingDetails
          modelAsString: true
      hiddenPropertyPaths:
        allOf:
        - $ref: '#/definitions/LoggingHiddenPropertyPath'
  ThirdPartyProviderAuthorization:
    type: object
    properties:
      authorizations:
        type: array
        items:
          $ref: '#/definitions/LightHouseAuthorization'
      managedByTenantId:
        type: string
  ResourceMovePolicy:
    type: object
    properties:
      validationRequired:
        type: boolean
      crossResourceGroupMoveEnabled:
        type: boolean
      crossSubscriptionMoveEnabled:
        type: boolean
  AuthorizationActionMapping:
    type: object
    properties:
      original:
        type: string
      desired:
        type: string
  Error:
    description: Standard error object.
    type: object
    properties:
      code:
        description: Server-defined set of error codes.
        type: string
        readOnly: true
      message:
        description: Human-readable representation of the error.
        type: string
        readOnly: true
      target:
        description: Target of the error.
        type: string
        readOnly: true
      details:
        description: Array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/Error'
        readOnly: true
      innerError:
        description: Object containing more specific information than  the current object about the error.
        allOf:
        - $ref: '#/definitions/InnerError'
        readOnly: true
  CustomRolloutStatus:
    type: object
    properties:
      completedRegions:
        type: array
        items:
          type: string
      failedOrSkippedRegions:
        type: object
        additionalProperties:
          $ref: '#/definitions/ExtendedErrorInfo'
  SubscriptionLifecycleNotificationSpecifications:
    type: object
    properties:
      subscriptionStateOverrideActions:
        type: array
        items:
          $ref: '#/definitions/SubscriptionStateOverrideAction'
      softDeleteTTL:
        format: duration
        type: string
  ErrorResponse:
    description: Standard error response.
    type: object
    properties:
      error:
        description: Standard error object.
        allOf:
        - $ref: '#/definitions/Error'
  CustomRolloutSpecification:
    required:
    - canary
    type: object
    properties:
      canary:
        allOf:
        - $ref: '#/definitions/TrafficRegions'
      providerRegistration:
        allOf:
        - $ref: '#/definitions/ProviderRegistration'
      resourceTypeRegistrations:
        type: array
        items:
          $ref: '#/definitions/ResourceTypeRegistration'
  ResourceProviderAuthorization:
    type: object
    properties:
      applicationId:
        type: string
      roleDefinitionId:
        type: string
      managedByRoleDefinitionId:
        type: string
  OpenApiValidation:
    type: object
    properties:
      allowNoncompliantCollectionResponse:
        description: Indicates whether a non compliance response is allowed for a LIST call
        type: boolean
  ProvisioningState:
    enum:
    - NotSpecified
    - Accepted
    - Running
    - Creating
    - Created
    - Deleting
    - Deleted
    - Canceled
    - Failed
    - Succeeded
    - MovingResources
    - TransientFailure
    - RolloutInProgress
    type: string
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  SubscriptionStateRule:
    type: object
    properties:
      state:
        enum:
        - NotDefined
        - Enabled
        - Warned
        - PastDue
        - Disabled
        - Deleted
        type: string
        x-ms-enum:
          name: SubscriptionState
          modelAsString: true
      allowedActions:
        type: array
        items:
          type: string
  TemplateDeploymentOptions:
    type: object
    properties:
      preflightSupported:
        type: boolean
      preflightOptions:
        type: array
        items:
          enum:
          - None
          - ContinueDeploymentOnFailure
          - DefaultValidationOnly
          type: string
          x-ms-enum:
            name: PreflightOption
            modelAsString: true
  LoggingHiddenPropertyPath:
    type: object
    properties:
      hiddenPathsOnRequest:
        type: array
        items:
          type: string
      hiddenPathsOnResponse:
        type: array
        items:
          type: string
  SwaggerSpecification:
    type: object
    properties:
      apiVersions:
        type: array
        items:
          type: string
      swaggerSpecFolderUri:
        type: string
  InnerError:
    description: Inner error containing list of errors.
    type: object
    properties:
      code:
        description: Specific error code than was provided by the containing error.
        type: string
        readOnly: true
      innerError:
        description: Object containing more specific information than the current object about the error.
        type: object
        readOnly: true
    additionalProperties:
      type: object
  CustomRolloutProperties:
    type: object
    required:
    - specification
    properties:
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The provisioned state of the resource.
      specification:
        allOf:
        - $ref: '#/definitions/CustomRolloutSpecification'
      status:
        allOf:
        - $ref: '#/definitions/CustomRolloutStatus'
  ResourceProviderManagement:
    type: object
    properties:
      schemaOwners:
        type: array
        items:
          type: string
      manifestOwners:
        type: array
        items:
          type: string
      incidentRoutingService:
        type: string
      incidentRoutingTeam:
        type: string
      incidentContactEmail:
        type: string
      serviceTreeInfos:
        type: array
        items:
          $ref: '#/definitions/ServiceTreeInfo'
      resourceAccessPolicy:
        enum:
        - NotSpecified
        - AcisReadAllowed
        - AcisActionAllowed
        type: string
      resourceAccessRoles:
        type: array
        items: {}
  LinkedAccessCheck:
    type: object
    properties:
      actionName:
        type: string
      linkedProperty:
        type: string
      linkedAction:
        type: string
      linkedActionVerb:
        type: string
      linkedType:
        type: string
  TypedErrorInfo:
    required:
    - type
    type: object
    properties:
      type:
        type: string
      info:
        type: object
        readOnly: true
parameters:
  GetRolloutNameParameter:
    in: path
    name: rolloutName
    description: The rollout name.
    required: true
    type: string
    x-ms-parameter-location: method
  ProviderNamespaceParameter:
    in: path
    name: providerNamespace
    description: The name of the resource provider hosted within ProviderHub.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'