openapi-directory/api/azure.com/azsadmin-ProductSecret.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Deployment Admin Client.","title":"DeploymentAdminClient","version":"2019-01-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"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/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"azsadmin-ProductSecret","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productPackages/{productId}/secrets":{"get":{"description":"Returns an array of product secrets.","operationId":"ProductSecrets_List","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Return product secrets list.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2019-01-01"},"examples":{"Return product secrets list.":{"value":"2019-01-01"}}},{"description":"The product identifier.","in":"path","name":"productId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Return product secrets list.":{"value":"Microsoft.IotHubPreview.1.0.2"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSecretsList"},"examples":{"Return product secrets list.":{"$ref":"#/components/examples/Return_product_secrets_list."}}}}}},"tags":["ProductSecrets"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productSecrets/{productId}/secrets/{secretName}":{"get":{"description":"Retrieves the specific product secret details.","operationId":"ProductSecrets_Get","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Return the product package details.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The product identifier.","in":"path","name":"productId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Return the product package details.":{"value":"Microsoft.IotHubPreview.1.0.2"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2019-01-01"},"examples":{"Return the product package details.":{"value":"2019-01-01"}}},{"$ref":"#/components/parameters/SecretNameParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSecret"},"examples":{"Return the product package details.":{"$ref":"#/components/examples/Return_the_product_package_details."}}}}},"404":{"description":"Not Found"}},"tags":["ProductSecrets"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productSecrets/{productId}/secrets/{secretName}/import":{"post":{"description":"Imports a product secret.","operationId":"ProductSecrets_Import","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Imports a product secret.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The product identifier.","in":"path","name":"productId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Imports a product secret.":{"value":"Microsoft.IotHubPreview.1.0.2"}}},{"$ref":"#/components/parameters/SecretNameParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2019-01-01"},"examples":{"Imports a product secret.":{"value":"2019-01-01"}}}],"requestBody":{"$ref":"#/components/requestBodies/SecretParameters"},"responses":{"200":{"description":"Accepted"},"404":{"description":"Not Found"}},"tags":["ProductSecrets"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productSecrets/{productId}/secrets/{secretName}/validate":{"post":{"description":"Validates a product secret.","operationId":"ProductSecrets_Validate","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Validates a product secret.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The product identifier.","in":"path","name":"productId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Validates a product secret.":{"value":"Microsoft.IotHubPreview.1.0.2"}}},{"$ref":"#/components/parameters/SecretNameParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2019-01-01"},"examples":{"Validates a product secret.":{"value":"2019-01-01"}}}],"requestBody":{"$ref":"#/components/requestBodies/SecretParameters"},"responses":{"200":{"description":"Accepted"},"404":{"description":"Not Found"}},"tags":["ProductSecrets"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Return_product_secrets_list.":{"value":{"value":[{"id":"/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1/secrets/AdHoc","name":"global/Microsoft.NullProvider.1.1/AdHoc","properties":{"description":"This is an ad-hoc secret.","expiresAfter":"P365D","provisioningState":"Succeeded","secretKind":"AdHoc","secretState":{"rotationStatus":"None","status":"NotUploaded"}},"type":"Microsoft.Deployment.Admin/locations/productPackages/secrets"},{"id":"/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1/secrets/TlsCertificate","name":"global/Microsoft.NullProvider.1.1/TlsCertificate","properties":{"description":"This is a TLS certificate.","expiresAfter":"P365D","provisioningState":"Succeeded","secretDescriptor":{"alternativeDnsNames":["noterp.redmond.ext-n22r1708.masd.stbtest.microsoft.com"],"keyLength":4096,"subject":"CN=NullProviderTLS"},"secretKind":"Certificate","secretState":{"rotationStatus":"None","status":"NotUploaded"}},"type":"Microsoft.Deployment.Admin/locations/productPackages/secrets"},{"id":"/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1/secrets/ExternalPassword","name":"global/Microsoft.NullProvider.1.1/ExternalPassword","properties":{"description":"This is an external password.","expiresAfter":"P365D","provisioningState":"Succeeded","secretDescriptor":{"allowedCharacters":"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz","passwordLength":10,"passwordValidationRegex":"^(?=.*\\d)(?=.*[A-Z])(?=.*[a-z]).*$"},"secretKind":"Password","secretState":{"rotationStatus":"None","status":"NotUploaded"}},"type":"Microsoft.Deployment.Admin/locations/productPackages/secrets"},{"id":"/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.NullProvider.1.1/secrets/ExternalSymmetricKey","name":"global/Microsoft.NullProvider.1.1/ExternalSymmetricKey","properties":{"description":"This is an external symmetric key.","expiresAfter":"P365D","provisioningState":"Succeeded","secretDescriptor":{"keyLength":128},"secretKind":"SymmetricKey","secretState":{"rotationStatus":"None","status":"NotUploaded"}},"type":"Microsoft.Deployment.Admin/locations/productPackages/secrets"}]}},"Return_the_product_package_details.":{"value":{"id":"/subscriptions/0a581108-e747-40cf-8a80-2c82ddd0438a/providers/Microsoft.Deployment.Admin/locations/global/productPackages/Microsoft.IotHubPreview.1.0.2/secrets/sslCert","name":"global/Microsoft.IotHubPreview.1.0.2/sslCert","properties":{"description":"Application SSL certificate.","expiresAfter":"P365D","provisioningState":"Succeeded","secretDescriptor":{"alternativeDnsNames":[],"keyLength":3072},"secretKind":"Certificate","secretState":{"rotationStatus":"None","status":"NotUploaded"}},"type":"Microsoft.Deployment.Admin/locations/productPackages/secrets"}}},"parameters":{"SecretNameParameter":{"description":"The secret name.","in":"path","name":"secretName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Return the product package details.":{"value":"secretName"},"Imports a product secret.":{"value":"secretName"},"Validates a product secret.":{"value":"secretName"}}}},"requestBodies":{"SecretParameters":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretParameters"}}},"description":"The parameters required for creating/updating a product secret.","required":true,"x-ms-parameter-location":"method"}},"securitySchemes":{"azure_auth":{"description":"Authorization uses an Azure Active Directory OAuth2 flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"AlternativeDnsNames":{"description":"List of alternative DNS names.","type":"string"},"AlternativeIpAddresses":{"description":"List of alternative IP Addresses.","type":"string"},"Password":{"description":"The password as a secure string.","type":"string"},"PfxFileName":{"description":"The pfx certificate file location.","type":"string"},"PfxPassword":{"description":"The pfx certificate file password as a secure string.","type":"string"},"ProductSecret":{"allOf":[{"description":"Object model of azure resource manager base.","properties":{"id":{"description":"ID of the resource.","readOnly":true,"type":"string"},"location":{"description":"Location of the resource.","type":"string"},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"type":{"description":"Type of Resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"Properties for a product secret.","properties":{"properties":{"$ref":"#/components/schemas/ProductSecretProperties"}},"type":"object"},"ProductSecretProperties":{"description":"Properties of product secret.","properties":{"description":{"description":"The secret description.","type":"string"},"expiresAfter":{"description":"The expiration period of the secret (in ISO8601 format).","type":"string"},"provisioningState":{"description":"Provisioning state of the resource.","type":"string"},"secretDescriptor":{"$ref":"#/components/schemas/SecretDescriptor"},"secretKind":{"description":"Specifies the secret kind.","enum":["AdHoc","Certificate","Password","StorageAccount","SymmetricKey"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SecretKind"}},"secretState":{"$ref":"#/components/schemas/SecretState"}},"type":"object"},"ProductSecretsList":{"description":"List of product secrets.","properties":{"nextLink":{"description":"URI to the next page.","type":"string"},"value":{"description":"List of product secrets.","items":{"$ref":"#/components/schemas/ProductSecret"},"type":"array"}}},"SecretDescriptor":{"description":"The secret type-specific descriptor.","properties":{"allowedCharacters":{"description":"The allowed characters in the password","type":"string"},"alternativeDnsNames":{"description":"Alternative DNS Names.","items":{"$ref":"#/components/schemas/AlternativeDnsNames"},"type":"array"},"alternativeIpAddresses":{"description":"The list of alternative IP addresses.","items":{"$ref":"#/components/schemas/AlternativeIpAddresses"},"type":"array"},"keyLength":{"description":"The key length.","type":"integer"},"passwordLength":{"description":"The minimum password length is 8 characters, and the maximum password length is 128 characters.","type":"integer"},"passwordValidationRegex":{"description":"Password validation regular expression.","type":"string"},"rotationStatus":{"description":"The storage account key secret rotation status.","enum":["None","PlantNewSak","RotateInactiveSak","Complete"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"RotationStatus"}},"secondaryKeyIsActive":{"description":"A value indicating whether the secondary or primary storage account key is active as a secret.","type":"boolean"},"subject":{"description":"Certificate's subject","type":"string"}},"type":"object"},"SecretParameters":{"description":"Parameters required for creating/updating a product secret.","properties":{"password":{"$ref":"#/components/schemas/Password"},"pfxFileName":{"$ref":"#/components/schemas/PfxFileName"},"pfxPassword":{"$ref":"#/components/schemas/PfxPassword"},"secretValue":{"$ref":"#/components/schemas/SecretValue"},"symmetricKey":{"$ref":"#/components/schemas/SymmetricKey"}},"type":"object"},"SecretRotationStatus":{"description":"Specifies the secret rotation status.","enum":["None","InProgress","Complete"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SecretRotationStatus"}},"SecretState":{"description":"Represents the secret state.","properties":{"expirationDate":{"description":"The secret expiration date.","format":"date-time","type":"string"},"rotationStatus":{"$ref":"#/components/schemas/SecretRotationStatus"},"status":{"$ref":"#/components/schemas/SecretStatus"}},"type":"object"},"SecretStatus":{"description":"Specifies the secret status.","enum":["NotUploaded","Uploaded","Deployed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SecretStatus"}},"SecretValue":{"description":"The secret value in a secure string format.","type":"string"},"SymmetricKey":{"description":"The symmetric key as a secure string.","type":"string"}}}}