swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DnssecConfigs API
schemes:
- https
tags:
- name: DnssecConfigs
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/dnssecConfigs/default
  : put:
      tags:
      - DnssecConfigs
      operationId: microsoftAzureDnssecconfigsCreateorupdate
      description: Creates or updates the DNSSEC configuration on a DNS zone.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ZoneNameParameter'
      - name: If-Match
        in: header
        required: false
        type: string
        x-ms-client-name: IfMatch
        description: The etag of the DNSSEC configuration. Omit this value to always overwrite the DNSSEC configuration. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes.
      - name: If-None-Match
        in: header
        required: false
        type: string
        x-ms-client-name: IfNoneMatch
        description: Set to '*' to allow this DNSSEC configuration to be created, but to prevent updating existing DNSSEC configuration. Other values will be ignored.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The DNSSEC configuration has been updated.
          schema:
            $ref: '#/definitions/DnssecConfig'
        '201':
          description: The DNSSEC configuration has been created.
          schema:
            $ref: '#/definitions/DnssecConfig'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Create DnssecConfig:
          $ref: ./examples/CreateOrUpdateDnssecConfig.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnszones Zonename Dnssecconfigs Default
    delete:
      tags:
      - DnssecConfigs
      operationId: microsoftAzureDnssecconfigsDelete
      description: Deletes the DNSSEC configuration on a DNS zone. This operation cannot be undone.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ZoneNameParameter'
      - name: If-Match
        in: header
        required: false
        type: string
        x-ms-client-name: IfMatch
        description: The etag of this DNSSEC configuration. Omit this value to always delete the DNSSEC configuration. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The DNSSEC configuration has been deleted.
        '202':
          headers:
            Location:
              description: Location URI to poll for result
              type: string
          description: The DNSSEC configuration delete operation has been accepted and will complete asynchronously.
        '204':
          description: The DNSSEC configuration was not found.
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete DnssecConfig:
          $ref: ./examples/DeleteDnssecConfig.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnszones Zonename Dnssecconfigs Default
    get:
      tags:
      - DnssecConfigs
      operationId: microsoftAzureDnssecconfigsGet
      description: Gets the DNSSEC configuration.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ZoneNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/DnssecConfig'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Get DnssecConfig:
          $ref: ./examples/GetDnssecConfig.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnszones Zonename Dnssecconfigs Default
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/dnssecConfigs
  : get:
      tags:
      - DnssecConfigs
      operationId: microsoftAzureDnssecconfigsListbydnszone
      description: Lists the DNSSEC configurations in a DNS zone.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ZoneNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/DnssecConfigListResult'
        default:
          description: Default response. It will be deserialized as per the Error definition.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List DnssecConfigs:
          $ref: ./examples/ListDnssecConfigsByZone.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnszones Zonename Dnssecconfigs
definitions:
  DnssecProperties:
    type: object
    properties:
      provisioningState:
        type: string
        description: Provisioning State of the DNSSEC configuration.
        readOnly: true
      signingKeys:
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/SigningKey'
        description: The list of signing keys.
        readOnly: true
    description: Represents the DNSSEC properties.
  CloudError:
    type: object
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: Cloud error body.
    description: An error response from the service.
  DnssecConfigListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DnssecConfig'
        description: Information about the DNSSEC configurations in the response.
      nextLink:
        type: string
        description: The continuation token for the next page of results.
        readOnly: true
    description: The response to a List DNSSEC configurations operation.
  SecurityAlgorithmType:
    type: integer
    format: int32
    description: 'The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml'
  CloudErrorBody:
    type: object
    x-ms-external: true
    properties:
      code:
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        type: string
        description: A message describing the error, intended to be suitable for display in a user interface.
      target:
        type: string
        description: The target of the particular error. For example, the name of the property in error.
      details:
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/CloudErrorBody'
        description: A list of additional details about the error.
    description: An error response from the service.
  SigningKey:
    type: object
    properties:
      delegationSignerInfo:
        type: array
        x-ms-identifiers: []
        items:
          $ref: '#/definitions/DelegationSignerInfo'
        description: The delegation signer information.
        readOnly: true
      flags:
        type: integer
        format: int32
        description: The flags specifies how the key is used.
        readOnly: true
      keyTag:
        type: integer
        format: int32
        description: The key tag value of the DNSKEY Resource Record.
        readOnly: true
      protocol:
        type: integer
        format: int32
        description: The protocol value. The value is always 3.
        readOnly: true
      publicKey:
        type: string
        description: The public key, represented as a Base64 encoding.
        readOnly: true
      securityAlgorithmType:
        $ref: '#/definitions/SecurityAlgorithmType'
        readOnly: true
    description: Represents the signing key.
  DigestAlgorithmType:
    type: integer
    format: int32
    description: 'The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml'
  DnssecConfig:
    type: object
    properties:
      properties:
        $ref: '#/definitions/DnssecProperties'
        x-ms-client-flatten: true
        description: The DNSSEC properties.
        readOnly: true
      id:
        type: string
        description: The ID of the DNSSEC configuration.
        readOnly: true
      name:
        type: string
        description: The name of the DNSSEC configuration.
        readOnly: true
      type:
        type: string
        description: The type of the DNSSEC configuration.
        readOnly: true
      etag:
        type: string
        description: The etag of the DNSSEC configuration.
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of the resource.
        readOnly: true
    x-ms-azure-resource: true
    description: Represents the DNSSEC configuration.
  DelegationSignerInfo:
    type: object
    properties:
      digestAlgorithmType:
        $ref: '#/definitions/DigestAlgorithmType'
        readOnly: true
      digestValue:
        type: string
        description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record.
        readOnly: true
      record:
        type: string
        description: The record represents a delegation signer (DS) record.
        readOnly: true
    description: The delegation signer information.
parameters:
  ZoneNameParameter:
    name: zoneName
    in: path
    required: true
    type: string
    description: The name of the DNS zone (without a terminating dot).
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'