openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 14.3 kB
JSON
{"openapi":"3.0.0","info":{"description":"The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.","title":"KeyVaultManagementClient","version":"2018-02-14-preview","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/keyvault/resource-manager/Microsoft.KeyVault/preview/2018-02-14-preview/secrets.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"keyvault-secrets","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets":{"get":{"description":"The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.","operationId":"Secrets_List","parameters":[{"description":"The name of the Resource Group to which the vault belongs.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"List secrets in the vault":{"value":"sample-group"}}},{"description":"The name of the vault.","in":"path","name":"vaultName","required":true,"schema":{"type":"string"},"examples":{"List secrets in the vault":{"value":"sample-vault"}}},{"description":"Maximum number of results to return.","in":"query","name":"$top","schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"Get information about secrets in the specified vault.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretListResult"},"examples":{"List secrets in the vault":{"$ref":"#/components/examples/List_secrets_in_the_vault"}}}}}},"tags":["Secrets"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}":{"get":{"description":"Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.","operationId":"Secrets_Get","parameters":[{"description":"The name of the Resource Group to which the vault belongs.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get a secret":{"value":"sample-group"}}},{"description":"The name of the vault.","in":"path","name":"vaultName","required":true,"schema":{"type":"string"},"examples":{"Get a secret":{"value":"sample-vault"}}},{"description":"The name of the secret.","in":"path","name":"secretName","required":true,"schema":{"type":"string"},"examples":{"Get a secret":{"value":"secret-name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"Retrieved secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secret"},"examples":{"Get a secret":{"$ref":"#/components/examples/Get_a_secret"}}}}}},"tags":["Secrets"]},"patch":{"description":"Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.","operationId":"Secrets_Update","parameters":[{"description":"The name of the Resource Group to which the vault belongs.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Update a secret":{"value":"sample-group"}}},{"description":"Name of the vault","in":"path","name":"vaultName","required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9-]{3,24}$"},"examples":{"Update a secret":{"value":"sample-vault"}}},{"description":"Name of the secret","in":"path","name":"secretName","required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9-]{1,127}$"},"examples":{"Update a secret":{"value":"secret-name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretPatchParameters"}}},"description":"Parameters to patch the secret","required":true},"responses":{"200":{"description":"Patched secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secret"},"examples":{"Update a secret":{"$ref":"#/components/examples/Update_a_secret"}}}}},"201":{"description":"Patched secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secret"},"examples":{"Update a secret":{"$ref":"#/components/examples/Update_a_secret"}}}}}},"tags":["Secrets"]},"put":{"description":"Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.","operationId":"Secrets_CreateOrUpdate","parameters":[{"description":"The name of the Resource Group to which the vault belongs.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Create a secret":{"value":"sample-group"}}},{"description":"Name of the vault","in":"path","name":"vaultName","required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9-]{3,24}$"},"examples":{"Create a secret":{"value":"sample-vault"}}},{"description":"Name of the secret","in":"path","name":"secretName","required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9-]{1,127}$"},"examples":{"Create a secret":{"value":"secret-name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretCreateOrUpdateParameters"}}},"description":"Parameters to create or update the secret","required":true},"responses":{"200":{"description":"Created or updated secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secret"},"examples":{"Create a secret":{"$ref":"#/components/examples/Create_a_secret"}}}}},"201":{"description":"Created or updated vault","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secret"},"examples":{"Create a secret":{"$ref":"#/components/examples/Create_a_secret"}}}}}},"tags":["Secrets"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_secrets_in_the_vault":{"value":{"value":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name","location":"westus","name":"secret-name","properties":{"attributes":{"created":1514941476,"enabled":true,"updated":1514941476},"secretUri":"https://sample-vault.vault.azure.net/secrets/secret-name","secretUriWithVersion":"https://sample-vault.vault.azure.net/secrets/secret-name/40af42fbc10047f8a756a73211492f56"},"type":"Microsoft.KeyVault/vaults/secrets"},{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name2","location":"westus","name":"secret-name2","properties":{"attributes":{"created":1514941476,"enabled":true,"updated":1514941476},"secretUri":"https://sample-vault.vault.azure.net/secrets/secret-name2","secretUriWithVersion":"https://sample-vault.vault.azure.net/secrets/secret-name2/cd7264a6f56c44d1b594423c80609aae"},"type":"Microsoft.KeyVault/vaults/secrets"}]}},"Get_a_secret":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name","location":"westus","name":"secret-name","properties":{"attributes":{"created":1514940950,"enabled":true,"updated":1514940950},"secretUri":"https://sample-vault.vault.azure.net/secrets/secret-name","secretUriWithVersion":"https://sample-vault.vault.azure.net/secrets/secret-name/77445834f7de41bab81d0723bf996860"},"type":"Microsoft.KeyVault/vaults/secrets"}},"Update_a_secret":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name","location":"westus","name":"secret-name","properties":{"attributes":{"created":1514940684,"enabled":true,"updated":1514940698},"secretUri":"https://sample-vault.vault.azure.net/secrets/secret-name","secretUriWithVersion":"https://sample-vault.vault.azure.net/secrets/secret-name/b8c802f549764f2d97885d152f92ee9d"},"type":"Microsoft.KeyVault/vaults/secrets"}},"Create_a_secret":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name","location":"westus","name":"secret-name","properties":{"attributes":{"created":1514938738,"enabled":true,"updated":1514938738},"secretUri":"https://sample-vault.vault.azure.net/secrets/secret-name","secretUriWithVersion":"https:/sample-vault.vault.azure.net/secrets/secret-name/baf6de32c4774c7c81345f6476cf90a4"},"type":"Microsoft.KeyVault/vaults/secrets"}}},"parameters":{"ApiVersionParameter":{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List secrets in the vault":{"value":"2018-02-14-preview"},"Get a secret":{"value":"2018-02-14-preview"},"Update a secret":{"value":"2018-02-14-preview"},"Create a secret":{"value":"2018-02-14-preview"}}},"SubscriptionIdParameter":{"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,"schema":{"type":"string"},"examples":{"List secrets in the vault":{"value":"00000000-0000-0000-0000-000000000000"},"Get a secret":{"value":"00000000-0000-0000-0000-000000000000"},"Update a secret":{"value":"00000000-0000-0000-0000-000000000000"},"Create a secret":{"value":"00000000-0000-0000-0000-000000000000"}}}},"securitySchemes":{"azure_auth":{"description":"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":{"Attributes":{"description":"The object attributes managed by the KeyVault service.","properties":{"created":{"description":"Creation time in seconds since 1970-01-01T00:00:00Z.","format":"unixtime","readOnly":true,"type":"integer"},"enabled":{"description":"Determines whether the object is enabled.","type":"boolean"},"exp":{"description":"Expiry date in seconds since 1970-01-01T00:00:00Z.","format":"unixtime","type":"integer","x-ms-client-name":"Expires"},"nbf":{"description":"Not before date in seconds since 1970-01-01T00:00:00Z.","format":"unixtime","type":"integer","x-ms-client-name":"NotBefore"},"updated":{"description":"Last updated time in seconds since 1970-01-01T00:00:00Z.","format":"unixtime","readOnly":true,"type":"integer"}}},"Secret":{"allOf":[{"description":"Key Vault resource","properties":{"id":{"description":"The Azure Resource Manager resource ID for the key vault.","readOnly":true,"type":"string"},"location":{"description":"The supported Azure location where the key vault should be created.","type":"string"},"name":{"description":"The name of the key vault.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"The tags that will be assigned to the key vault. ","type":"object"},"type":{"description":"The resource type of the key vault.","readOnly":true,"type":"string"}},"required":["location"],"x-ms-azure-resource":true}],"description":"Resource information with extended details.","properties":{"properties":{"$ref":"#/components/schemas/SecretProperties"}},"required":["properties"]},"SecretAttributes":{"allOf":[{"$ref":"#/components/schemas/Attributes"}],"description":"The secret management attributes."},"SecretCreateOrUpdateParameters":{"description":"Parameters for creating or updating a secret","properties":{"properties":{"$ref":"#/components/schemas/SecretProperties"},"tags":{"additionalProperties":{"type":"string"},"description":"The tags that will be assigned to the secret. ","type":"object"}},"required":["properties"],"x-ms-azure-resource":true},"SecretListResult":{"description":"List of secrets","properties":{"nextLink":{"description":"The URL to get the next set of secrets.","type":"string"},"value":{"description":"The list of secrets.","items":{"$ref":"#/components/schemas/Secret"},"type":"array"}}},"SecretPatchParameters":{"description":"Parameters for patching a secret","properties":{"properties":{"$ref":"#/components/schemas/SecretPatchProperties"},"tags":{"additionalProperties":{"type":"string"},"description":"The tags that will be assigned to the secret. ","type":"object"}},"x-ms-azure-resource":true},"SecretPatchProperties":{"description":"Properties of the secret","properties":{"attributes":{"$ref":"#/components/schemas/SecretAttributes"},"contentType":{"description":"The content type of the secret.","type":"string"},"value":{"description":"The value of the secret.","type":"string"}}},"SecretProperties":{"description":"Properties of the secret","properties":{"attributes":{"$ref":"#/components/schemas/SecretAttributes"},"contentType":{"description":"The content type of the secret.","type":"string"},"secretUri":{"description":"The URI to retrieve the current version of the secret.","readOnly":true,"type":"string"},"secretUriWithVersion":{"description":"The URI to retrieve the specific version of the secret.","readOnly":true,"type":"string"},"value":{"description":"The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.","type":"string"}}}}}}