swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ClusterServices API
schemes:
- https
tags:
- name: ClusterServices
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.MobilePacketCore/clusterServices:
    get:
      operationId: microsoftAzureClusterservicesListbysubscription
      tags:
      - ClusterServices
      description: List all Cluster Services by Subscription ID.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/ClusterServiceResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        ClusterServices_ListBySubscription:
          $ref: ./examples/ClusterService_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Mobilepacketcore Clusterservices
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/clusterServices:
    get:
      operationId: microsoftAzureClusterservicesListbyresourcegroup
      tags:
      - ClusterServices
      description: List all Cluster Services by Resource Group.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/ClusterServiceResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        ClusterServices_ListByResourceGroup:
          $ref: ./examples/ClusterService_ListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Mobilepacketcore Clusterservices
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/clusterServices/{clusterServiceName}
  : get:
      operationId: microsoftAzureClusterservicesGet
      tags:
      - ClusterServices
      description: Get a ClusterServiceResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: clusterServiceName
        in: path
        description: The name of the Cluster Service
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/ClusterServiceResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        ClusterServices_Get:
          $ref: ./examples/ClusterService_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Mobilepacketcore Clusterservices Clusterservicename
    put:
      operationId: microsoftAzureClusterservicesCreateorupdate
      tags:
      - ClusterServices
      description: Create a ClusterServiceResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: clusterServiceName
        in: path
        description: The name of the Cluster Service
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/ClusterServiceResource'
      responses:
        '200':
          description: ARM resource update successful
          schema:
            $ref: '#/definitions/ClusterServiceResource'
        '201':
          description: Azure create operation completed successfully.
          schema:
            $ref: '#/definitions/ClusterServiceResource'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        ClusterServices_CreateOrUpdate:
          $ref: ./examples/ClusterService_CreateOrUpdate.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Mobilepacketcore Clusterservices Clusterservicename
    patch:
      operationId: microsoftAzureClusterservicesUpdatetags
      tags:
      - ClusterServices
      description: Update a ClusterServiceResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: clusterServiceName
        in: path
        description: The name of the Cluster Service
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      - name: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/ClusterServiceResourceTagsUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/ClusterServiceResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        ClusterServices_UpdateTags:
          $ref: ./examples/ClusterService_UpdateTags.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Mobilepacketcore Clusterservices Clusterservicename
    delete:
      operationId: microsoftAzureClusterservicesDelete
      tags:
      - ClusterServices
      description: Delete a ClusterServiceResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: clusterServiceName
        in: path
        description: The name of the Cluster Service
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        ClusterServices_Delete:
          $ref: ./examples/ClusterService_Delete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Mobilepacketcore Clusterservices Clusterservicename
definitions:
  ClusterServiceResourceListResult:
    type: object
    description: The response of a ClusterServiceResource list operation.
    properties:
      value:
        type: array
        description: The ClusterServiceResource items on this page
        items:
          $ref: '#/definitions/ClusterServiceResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  ComponentDeploymentSecrets:
    type: string
    description: Containerized Network Function (CNF) Component Secrets
  OperationalStatus:
    type: object
    description: Operational Status of the resource
    properties:
      workload:
        type: string
        description: Status of the deployed workload
        readOnly: true
      healthCheck:
        type: string
        description: Health check results
        readOnly: true
  ClusterServiceResource:
    type: object
    description: Azure for Operators 5G Core Cluster Service Resource
    properties:
      properties:
        $ref: '#/definitions/ClusterServiceResourceProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
  SkuDeploymentType:
    type: string
    description: Deployment Type Definitions
    enum:
    - Production
    - Lab
    x-ms-enum:
      name: SkuDeploymentType
      modelAsString: true
      values:
      - name: Production
        value: Production
        description: Production Deployment
      - name: Lab
        value: Lab
        description: Lab Deployment
  ReleaseVersion:
    type: string
    description: Azure for Operators 5G Core Release Version.
  QualifiedComponentDeploymentParameters:
    type: object
    description: Containerized Network Function (CNF) Qualified Deployment Parameters
    properties:
      type:
        $ref: '#/definitions/ComponentDeploymentType'
        description: Federation Type
      parameters:
        $ref: '#/definitions/ComponentDeploymentParameters'
        description: Deployment Parameters
      secrets:
        $ref: '#/definitions/ComponentDeploymentSecrets'
        format: password
        description: Deployment secrets
        x-ms-secret: true
    required:
    - type
  ProvisioningState:
    type: string
    description: Provisioning state of the resource
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Provisioning
    - Updating
    - Deleting
    - Accepted
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Succeeded
        value: Succeeded
        description: Resource has been created.
      - name: Failed
        value: Failed
        description: Resource creation failed.
      - name: Canceled
        value: Canceled
        description: Resource creation was canceled.
      - name: Provisioning
        value: Provisioning
        description: Resource is getting provisioned
      - name: Updating
        value: Updating
        description: Resource is updating
      - name: Deleting
        value: Deleting
        description: Resource is getting deleted
      - name: Accepted
        value: Accepted
        description: Resource has been accepted
    readOnly: true
  ComponentDeploymentType:
    type: string
    description: Containerized Network Function (CNF) Component Deployment Type
  ClusterType:
    type: string
    description: Cluster Type Definitions
    enum:
    - Aks
    - NexusAks
    x-ms-enum:
      name: ClusterType
      modelAsString: true
      values:
      - name: Aks
        value: Aks
        description: Azure Kubernetes Service
      - name: NexusAks
        value: NexusAks
        description: Azure Operator Nexus Kubernetes Service
  ClusterServiceClusterTypeSpecificData:
    type: object
    description: Cluster Service cluster type specific data.
    properties:
      type:
        $ref: '#/definitions/ClusterType'
        description: Cluster Type
      customLocationId:
        $ref: '#/definitions/CustomLocationIdProperty'
        description: Custom Location resource ID
    discriminator: type
    required:
    - type
    - customLocationId
  ComponentDeploymentParameters:
    type: string
    description: Containerized Network Function (CNF) Component Deployment Parameters
  CustomLocationIdProperty:
    type: string
    format: arm-id
    description: ARM resource ID of a custom location.
    x-ms-arm-id-details:
      allowedResources:
      - type: Microsoft.ExtendedLocation/customLocations
  ClusterServiceResourceTagsUpdate:
    type: object
    description: The type used for updating tags in ClusterServiceResource resources.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
  ClusterServiceResourceProperties:
    type: object
    description: Cluster Service Properties.
    properties:
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
      deploymentType:
        $ref: '#/definitions/SkuDeploymentType'
        description: Cluster type (Lab or Production)
        x-ms-mutability:
        - read
        - create
      releaseVersion:
        $ref: '#/definitions/ReleaseVersion'
        description: Azure for Operators 5G Core Release Version.  This is applied to all platform as a service (PaaS) components and running workloads in this cluster
      clusterTypeSpecificData:
        $ref: '#/definitions/ClusterServiceClusterTypeSpecificData'
        description: Cluster type specific data.  Contents depend on the cluster type
      componentParameters:
        type: array
        description: Azure for Operators 5G Core Local PaaS component parameters.  One set per component type
        items:
          $ref: '#/definitions/QualifiedComponentDeploymentParameters'
        x-ms-identifiers:
        - type
      operationalStatus:
        $ref: '#/definitions/OperationalStatus'
        description: Operational status
        readOnly: true
    required:
    - deploymentType
    - releaseVersion
    - clusterTypeSpecificData
    - componentParameters
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'